首先需要有node.js的环境,然后下载
(尽量cmd管理员身份运行)
npm install apidoc -g
下载好之后在项目根目录下新建apidoc.json
配置信息(示例)
{
"name": "xxx网站接口文档",
"version": "1.1.0",
"description": "公司内部文档,请勿外传",
"title": "xxx网站接口文档",
"url" : "http://xxx.xxx.com:3000/api/v1",
"sampleUrl": "http://localhost:3000/api/v1",
"template": {
"withCompare": true,
"withGenerator": false
}
}
!这里我也是扒的md文档,没找到出处,如果有人知道欢迎告诉我补充
-
name, version, description
-这三个配置项的内容会显示在生成文档的最上方,其中name即整个文档的大标题。 -
title
- 网页的标题,显示在浏览器标签上。
-
url
- 文档中每个API地址的前缀。
-
sampleUrl
- 当有此项时,每个API文档的最后会有Sample Request测试部分。该配置项是测试API地址的前缀。
-
header, footer
- 页面的头和尾。当多个页面都有相同的