Nest 使用 apidoc 生成接口文档

安装 apidoc

npm install apidoc -g

配置 apidoc

在项目根目录下创建 apidoc.json 文件，并添加以下内容：

• url 就是显示在接口地址前面的地址它会拼接接口路由前面

{
  "name": "XXX管理系统",
  "version": "0.0.0",
  "description": "接口文档描述",
  "output": "/docs", // 生成文档的目录
  "input": ["./src"], // 需要生成文档的目录
  "title": "接口文档",
  "url": "https://api.github.com/"
}

生成接口文档

在项目根目录下执行以下命令：

apidoc  -c ./apidoc.json --write-json

• 打包后 就会在项目的根目录下面生成一个 docs 的文件夹，里面就是生成的接口文档

• 找到 assets 目录下面有个 api-data.json

• 利用 apifox 导入这个 api-data.json 就可以了

vscode 插件

• 安装 ApiDoc Snippets 插件

• 使用快捷命令 输入 apidocument

• 然后 在生成的里面改即可

举例如下

/**
 *
 * @api {POST} /user/register 注册用户
 * @apiName  注册用户
 * @apiGroup user
 * @apiVersion  0.0.0
 *
 * @apiBody  {String} username 用户名
 * @apiParam  {String} username 用户名
 *
 * @apiSuccess (200) {Number} code 状态码
 *
 * @apiParamExample  {type} Request-Example:
 * {
 *     property : value
 * }
 *
 *
 * @apiSuccessExample {type} Success-Response:
 * {
 *     property : value
 * }
 *
 *
 */