常用的接口文档有很多,可以使用apidoc、swagger这两个模块
apidoc的用法:
1.首先window用户:cnpm i apidoc -g mac:sudo cnpm i apidoc -g (mac用户,输入开机密码---不可见)
2.// 修改package.json,添加apidoc的配置选项
{
"name": "my-admin-app",
"version": "0.0.0",
"private": true,
"scripts": {
},
"dependencies": {
},
"apidoc": {
"title": "标题",
"url": "http://localhost:3000" // 根据自己的端口号实时更新
}
}
3.根据apidoc的规范编写接口文档,范例 get请求,api文件夹下的pro.js文件中写的接口
4.每更新一个接口文档,运行以下命令(找到api文件夹下的所有配置过接口文档的 路由,编译到 public目录下的 apidoc文件夹)
此命令在项目的根目录下运行,不是在 api文件夹下
> apidoc -i api/ -o public/apidoc
5.通过 http://localhost:3000/apidoc 访问接口文档