yii2-apidoc
安装
C/C++ Code复制内容到剪贴板
- npm install -g apidoc
Mac下安装路径为:/usr/local/lib/node_modules
例:在项目web目录创建apidoc.json
PHP Code复制内容到剪贴板
- {
- "name": "api",
- "version": "1.0.0",
- "description": "内审系统API接口文档",
- "title": "api接口",
- "url" : "http://api.au.vip",
- "sampleUrl" : "http://api.au.vip",
- "template": {
- "withGenerator": false
- }
- }
将根目录下的api,生成到 根目录 > web > api > doc
设当前目录是根目录下的web目录,在根目录 > web目录执行:
PHP Code复制内容到剪贴板
- apidoc -i ../api/ -o api/doc
使apidoc支持中文
1、找到安装目录 中 api_group.js
node_modules/apidoc-core/lib/workers/api_group.js
2、注释代码
vim api_group.js
//group = group.replace(/[^\w]/g, '_');