登录ApiDoc官网,熟悉官方文档 ApiDoc官网
由官网所知,我们使用WebStorm创建好Express项目后,需要安装一个ApiDoc库,代码如下:
npm i apidoc -g #全局安装
方式一:根目录配置apidoc.json
{
"name": "node版前台接口文档",
"version": "0.0.1",
"description": "前台接口",
"title": "Node version foreground interface document",
"url" : "http://localhost:3000/api/index"
}
方式二:项目package.json配置api-doc