@jinka/egg-api-doc

egg-api-doc

基于 api-doc 的 API 文档

配置

// package.json
"scripts": {
	"doc": "apidoc -i app -o apidoc -c apidoc.json"
}

// apidoc.json
{
	"name": "wechat-admin-server",
	"version": "0.0.1-alpha.1",
	"description": "apiDoc basic example",
	"title": "Custom apiDoc browser title",
	"url" : "http://127.0.0.1:2222",
	"sampleUrl" : true
}

第一次

npm run doc

启动

http://127.0.0.1:port/index.html