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