如何使用apidoc自动生成接口文档。

原创 2018年04月16日 14:20:47

1.首先,去node.js官网上下载最新的安装包,请下载自己对应系统的安装包,下载完毕后,按照一般的软件安装步骤安装即可。

2.win+R,输入cmd,打开命令行界面,

①.输入node,按回车,

②.再输入npm,再按回车,

③.最后输入npm install apidoc -g,按回车

④.等待一定时间(根据自身的网速)即可下载和安装成功。

3.进入这个路径,C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers\api_group.js;

注释掉//group = group.replace(/[^\w]/g, '_')

(这个插件是老外搞出来的,虽然兼容了中文,但还有点小问题,就是在@apiGroup这里无法使用中文,坑的一批,步骤3就是解决这个坑的方法,一定不能忽略)。

4.在你的controller中书写备注,示范如下:

    /**
     * @api {post} /api-security/get-token 获取TOKEN
     * @apiVersion 1.0.0
     * @apiName getToken
     * @apiGroup 安全校验类
     *
     * @apiParam {string} aes 来源
     * @apiParam {string} key 签名
     *
     * @apiSuccess {string} error 状态码1.成功、0.失败
     * @apiSuccess {string} code 错误码码10000.Successful、10005.非法请求、10007.参数错误、2001.验证码过期、2002.验证码错误,2003.尚未生成验证码
     * @apiSuccess {string} msg 返回详情
     * @apiSuccess {array[]} result 结果集
     *
     * @apiSuccessExample Success-Response:
     * HTTP/1.1 10000 OK
     * {
     *   "error":1,
     *   "code":"10000",
     *   "msg":"成功创建新TOKEN",
     *   "result":{
     *     "token":"2cea24050cfe8bc37f55fc03487cb9a5"
     *   }
     * }
     */

5.新建apidoc.json文件,文件内容如下:

{
  "name" : "API文档",
  "version": "1.0.0",
  "title": "呵呵哒-API文档",
  "description": "呵呵哒-API文档,仅限内部使用",
  "url" : "http://www.baidu.com"
}

我的目录结构如下:


我将这个apidoc.json文件放在client文件夹下。

6.生成命令是

apidoc -i 目录1 -o 目录2

现在我在client目录下,新建文件夹apidoc,输入

apidoc -i controllers/ -o apidoc/

就可以在client目录下生成一个apidoc文档,

可以将接口文档生成在其他目录下,只要输入正确的路径,示范如下:

apidoc -i controllers/ -o E:/apidoc/

7.生成文档。

这是生成的效果:


over.

这篇文章是极简版,apidoc其中玄妙不可道尽,感兴趣者可以查看官方文档.或者阅读下这篇博主的文章


如需转载,请注明出处:https://blog.csdn.net/GlatChen/article/details/79959684



版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/GlatChen/article/details/79959684

laravel apidoc工具使用

apidoc是一种风格优雅的API文档生成工具。 第一步:安装nodejs curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash...
  • cjqh_hao
  • cjqh_hao
  • 2017-02-28 09:07:56
  • 1301

apidoc接口文档自动生成工具

使用背景 : 由于后端接口开发好,提供接口文档供前端人员调用;由于某种原因,修改了接口,文档没有及时更新,导致后续交接或联调时接口文档不匹配;使用apidoc文档自动生成工具,解决这一问题。 ...
  • cengjingcanghai123
  • cengjingcanghai123
  • 2017-03-19 23:43:29
  • 3627

使用apidoc管理RESTful风格Flask项目接口文档

使用apidoc管理RESTful风格Flask项目接口文档 apidoc项目地址 flask扩展包地址 文档示例地址 1.安装nodejs sudo apt-get install...
  • lynnyq
  • lynnyq
  • 2018-02-04 19:19:06
  • 371

使用apidoc自动生成接口文档

1.apidoc的使用需借助npm,即你首先需要安装node js2.然后开始->运行->cmd->npm install apidoc -g 进行全局安装a...
  • m0_38001814
  • m0_38001814
  • 2018-04-08 18:04:05
  • 51

springmvc集成Swagger自动生成api文档

springmvc集成Swagger自动生成api文档准备工作下载swaggerUI: https://github.com/swagger-api/swagger-ui maven项目中,添加pom...
  • duanjiajia
  • duanjiajia
  • 2017-01-11 10:56:37
  • 2160

用apidoc 生成在线接口文档

用apidoc工具生成在线html版接口文档
  • Zhaoruifeng158
  • Zhaoruifeng158
  • 2017-03-23 17:14:33
  • 3381

Web API文档生成工具apidoc 的使用步骤

1.安装node.js(以window为例) 32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi 64 位安装包下载地...
  • rorntuck7
  • rorntuck7
  • 2016-08-29 17:40:55
  • 1704

apidoc写php接口文档

1.apidoc需要node.js支持,需要安装node.js 2.通过npm安装apidoc  npm install apidoc -g 3. 在项目目录里面创建apidoc相关信息,一般是放根...
  • hu_feng903
  • hu_feng903
  • 2017-08-23 23:05:16
  • 719

使用apidoc 生成Restful web Api文档

在项目开发过程中,总会牵扯到接口文档的设计与编写,之前使用的都是office工具,写一个文档,总也是不够漂亮和直观。好在git上的开源大神提供了生成文档的工具,so来介绍一下! 该工具是Nodejs...
  • soslinken
  • soslinken
  • 2016-01-06 17:29:10
  • 35106

使用apidocJs快速生成在线文档

apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java、C、C#、PHP和Javascript等。使用者仅需要按照要求书写相关注释,就可以生成可读性好、界面美观的在线接...
  • xialei199023
  • xialei199023
  • 2017-03-18 10:40:00
  • 8457
收藏助手
不良信息举报
您举报文章:如何使用apidoc自动生成接口文档。
举报原因:
原因补充:

(最多只允许输入30个字)