apidoc文档生成

 

1、首先要确认你的系统安装了nodejs，然后执行npm install -g apidoc即可。

2 、配置apidoc，在你的项目下创建apidoc.json文件，apidoc.json说明（该文件可以随便放置，主要执行apidoc -i src/ -o apidoc/ 命令时，是在该文件目录下就行，具体下面会详细解释）；

apidoc.json 内容如下：

=============================

{
    "name": "测试APIs",    
    "version": "1.0.0",                
    "description": "接口测试",
    "title": "test APIs",
    "url" : "http://localhost:9220/sapi/v1/production_plan",
    "sampleUrl" : "http://localhost:9220/sapi/v1/production_plan"
}

=============================

 

执行命令 apidoc -i src/ -o apidoc/ （此命令需在刚才创建的json文件目录下执行）

• -i src/是把src文件夹下带有apidoc语法注释的代码全部生成文档
• -o apidoc/是文档的生成目录
  一切大功告成，打开apidoc文件夹下的index.html文件

此文主要是用于个人学习笔记，感谢 小菜荔枝 参考链接

https://www.jianshu.com/p/3d39d2a3e78f