开源的api文档管理系统

api文档php在项目中，需要协同开发，所以会写许多API文档给其他同事，以前都是写一个简单的TXT文本或Word文档，口口相传，这种方式比较老土了，所以，需要有个api管理系

• api文档
 
• php

• 在项目中，需要协同开发，所以会写许多API文档给其他同事，以前都是写一个简单的TXT文本或Word文档，口口相传，这种方式比较老土了，所以，需要有个api管理系统专门来管理这些api，从网上找了许多比较好的开源文档管理系统，可以应用到项目中。

1、国外的话Swaggerswagger-ui

2、国内的Showdoc国内开源的非常好用的一款API文档管理系统，安装也非常方便，只需将源代码放到项目目录下自动安装运行即可，不要要注意PHP版本必须大于5.3.

"+data); }); com.stderr.on(\'data\', function (data) { console.log(\'生成错误啦->\' + data); });}if(fs.existsSync(\'./api\') }else{ init();}

安装gaze包，然后执行watch.js文件：

➜ apidoc cnpm install gaze[gaze@*] installed at node_modules/.1.1.2@gaze (14 packages, use 2s, speed 54.93kB/s, json 85.75kB, tarball 0B)All packages installed (14 packages installed from npm registry, use 2s, speed 54.62kB/s, json 17(85.75kB), tarball 0B)➜ apidoc node watch.js/WEB/apidoc/api/apidoc.json was changed生成Api->info: Done.

api参数：

Usage: C:\Program Files\nodejs\node.exe apidoc [options]Options: -f, --file-filters RegEx-Filter to select files that should be parsed (multiple -f can be used) -e, --exclude-filters RegEx-Filter to select files / dirs that should not be parsed (many -e can b -i, --input Input / source dirname. [./] -o, --output Output dirname. [./doc/] -t, --template Use template for output files. [C:\Users\Administrator\AppData\Roaming\npm\ -c, --config Path to directory containing config file (apidoc.json) [./] -p, --private Include private APIs in output. [false] -v, --verbose Verbose debug output. [false] -h, --help Show this help information. --debug Show debug messages. [false] --color Turn off log color. [true] --parse Parse only the files and return the data, no file creation. [false] --parse-filters Optional user defined filters. Format name=filename --parse-languages Optional user defined languages. Format name=filename --parse-parsers Optional user defined parsers. Format name=filename --parse-workers Optional user defined workers. Format name=filename --silent Turn all output off. [false] --simulate Execute but not write any file. [false] --markdown Turn off default markdown parser or set a file to a custom parser. [true] --line-ending Turn off autodetect line-ending. Allowed values: LF, CR, CRLF. --encoding Set the encoding of the source code. [utf8]. [utf8]

执行生成文档命令

D:\code\api_doc>apidoc -i example/ -o doc/info: Done.D:\POCO\api_doc>

12、PHP_DOC 实时生成 API 文档https://segmentfault.com/a/11...