ThinkPHP ApiDoc 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
ThinkPHP ApiDoc 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
ThinkPHP ApiDoc 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
ThinkPHP ApiDoc 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
ThinkPHP ApiDoc 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 MIT
开发语言 PHP 查看源码 »
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 HG-CODE
适用人群 未知
收录时间 2021-04-09

软件简介

ThinkPHP ApiDoc 是一款基于 ThinkPHP 根据注释自动生成 API 接口文档的工具。

🤷‍♀️ Apidoc是什么?

如今,前后端分离的开发模式以必不可少,基于ThinkPHP你可以很方便的作为后端Api的开发。可是一个Api开发过程中需要快速调试,开发完成后需要给其它开发者对接,这时一个详细的Api文档,就显得特别重要。

大多数开发者可能都是通过各种工具配合来达到这一目的,其各种工具的安装和配置也是繁琐。甚至还有通过word等文本工具手写api文档的,这样的开发效率与可维护性是非常差的。

综合种种Api开发中的痛点,我们专为ThinkPHP开发了Apidoc的扩展插件,本插件可通过简单的注解即可生成Api文档,及帮助开发者提高生产效率的在线调试、快速生成Crud、一键生成整个模块Api等,涵盖Api开发方方面面。

✨特性

  • 开箱即用:无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
  • 在线调试:在线文档可直接调试,支持设置全局参数,接口调试省时省力。
  • 轻松编写:支持公共注释定义、业务逻辑层、数据表字段的引用,几句注释即可完成。
  • 安全高效:访问API文档页面需密码验证;支持缓存接口数据,无需每次都生成数据。
  • 多应用/多版本:可适应各种单应用、多应用、多版本的项目的Api管理。
  • Markdown文档:支持.md文件的文档展示。
  • 快速生成Crud:配置+模板即可快速生成Crud接口代码及数据表的创建,大大提高工作效率。
  • 控制器分组:更精细化的对控制器接口进行分组展示。

📌兼容

ThinkPHP 6.x

如需在 ThinkPHP 5.x 版本中使用,请安装 V1.x版本 V1.x版本安装说明

📖使用文档

ThinkPHP ApiDoc V2.x文档

ThinkPHP ApiDoc V1.x文档

🏆支持我们

如果本项目对您有所帮助,请点个Star支持我们

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
暂无内容
2018/12/29 09:53

apidoc

安装apidoc 完成后。按如图apidoc文件夹创建文件夹和文件。 apidoc的目录结构如上图。 编译过程: 1,在目录盘中找到apidoc文件夹--〉按住键盘shift+鼠标右键。选中[在此打开命令窗口] 2,执行命令:apidoc -i doc/ -o output/ 回车就ok了。

0
0
发表于开发技能专区
2018/03/31 23:22

apidoc windows

前言 后端写代码前,最后将mock代码发布出来,并将api文档提供给前端,这样可以进入并行开发状态。 以前全很土,用word传来传去,现在好了,用apidoc,在线文档,非常爽。 1分钟快速上手 环境:Win7+Intellij15 1、apidoc是用node.js开发的,因此要先安装NodeJs环境。非常简单,是一个Msi文件,一路回车即可。 下载地址 2、下载好后,它是自动进入环境变量里面的。 3、在dos下面,输入 npm install -g apidoc 至此,apidoc安装成...

0
0
发表了博客
2019/11/11 11:31

apiDoc的使用

一、安装   1.安装node.js,下载链接:https://nodejs.org/zh-cn/   2.安装apiDoc,命令行:npm install apidoc -g 二、配置 在项目中配置apidoc.json文件(我的配置在接口文件夹下),该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。 { "name": "ServiceEbikeAPIs", "version": "3.1.0", "description": "项目接口文档", "title": "接口测试文档", "url" : "htt...

0
0
发表了博客
2018/12/18 09:17

apidoc 工具的使用

使用rest framerok时,需要写API接口文档,此时就需要用到 apidoc(个人觉得这个用的比较顺手) 需要安装nodejs,,, windows 下   1 然后验证是否安装成功 node -v   2 安装完nodejs环境后,会自带npm,npm为nodejs包管理工具,安装apidoc :npm install apidoc -g,      安装完成后,使用apidoc -h,查看是否安装成功   3 C:\nodejs\ex>apidoc -i c://nodejs/ex/ -o apidoc/ [使用,apidoc.json一定要放在同级目录]    ...

0
0
发表了博客
2019/05/27 16:32

centos7下安装apidoc

提前安装好Web服务器 wget https://nodejs.org/dist/v8.1.2/node-v8.1.2-linux-x64.tar.xz 执行解压xz的命令: ​xz -d node-v8.1.2-linux-x64.tar.xz 如果xz命令不存在则先安装xz: https://sourceforge.net/projects/lzmautils/files/latest/download?source=typ_redirect 上传安装包到服务器,解压,安装 tar -zxvf xz-5.2.4.tar.gz cd xz-5.2.4 mkdir /usr/local/xz ./configure --prefix=/usr/local/xz #指定安装目录...

0
0
发表了博客
2018/10/11 14:24

ubuntu下安装apidoc

1.到http://nodejs.cn/download/下载nodejs 可以复制链接 使用wget下载更加快速 选择对应的操作系统位数 下载到/usr/local/src 此处强烈不建议编译安装 因为需要更新gcc等操作 耗时很长 还会出错 2.解压 将整个目录copy到 /usr/local下 取名叫nodejs 3.进入到nodejs/bin目录下 将node npm关联到/usr/sbin ln -s /usr/local/nodejs/bin/node /usr/sbin/node ln -s /usr/local/nodejs/bin/npm /usr/sbin/npm 4.安装apidoc npm in...

0
0
发表了博客
2019/09/24 20:46

浅谈apidoc的使用

使用前提:服务器已经安装好apidoc了 1.项目根目录建立 apidoc.json ,文件基础信息如下 { "name": "项目名称", "version": "这里是版本号", "description": "项目接口文档" } 2.代码中的注释严格按照apidoc的规则来 官方示例 参考博文 搜索一下 3.运行命令以生成接口文档 apidoc -i ../api/ -o ./apidoc/ 命令解释: -i 后面的参数是需要生成接口文档的模块对于当前文件( apidoc.json )的相对路径 -o 后面的参...

0
0
发表了博客
2019/04/17 18:11

laravel中使用apidoc

apidoc官方文档:http://apidocjs.com/#params 第一步:使用:npm install apidoc -g 第二步:在项目根目录下新建apidoc.json文件,文件内容格式参考如下: {   "name": "laravel5 API文档",   "version": "v1.0",   "description": "本文档提供laravel5 商品,订单,收货地址,等API文档供嗨聊服务端开发人员作为参考,文档使用RESTfull风格,如有疑问请联系开发者",   "apidoc": {     "title": "laravel5 API文档...

0
0
发表了博客
2018/05/09 10:23

接口文档神器之apidoc

//@desn:apidoc linux环境 windows环境使用 //@desn:码字不宜,转载请注明出处 //@author:张慧源 <turing_zhy@163.com> //@date:2018/5/6 正文: windows版安装: 1.安装nodejs (nodejs环境) 32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi 64 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi 2.安装apidoc, npm install -g apidoc 使用第一个命令版 运行上面的命令安装...

0
0
发表了博客
2019/09/24 13:51

Linux安装apidoc

一.安装apidoc所需环境(nodejs) 1. 查看系统是32位还是64位 uname -r 可以看出我这台linux的是64位的 2. 到node官网下载node的包并上传linux https://nodejs.org/en/ 然后通过ftp上传到/usr/bin目录下 3. 进入文件所在目录,解压,重命名 cd /usr/bin tar -xvf node-v10.15.3-linux-x64.tar.xz mv node-v10.15.3-linux-x64 nodejs 4. 建立软连接,变为全局环境变量。 ln -s /usr/bin/nodejs/bin/npm /usr/local/bin/ ln -s /...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
0 评论
5 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部