swagger生成php接口文档

1. 安装前端

git clone https://github.com/swagger-api/swagger-ui.git

swagger-ui下载

下载之后找到dist目录, 打开index.html把其中的那一串url改成自己的, 比如http://localhost/yii2/swagger-docs/swagger.json

然后打开URL就可以看到前端界面了, 应该是没内容的, 因为还没生成swagger.json, 生成好之后你设置的URL就起了作用, 直接访问前端就好

http://localhost/yii2/swagger-ui/dist/index.html

2. 安装后端

php composer.phar require zircote/swagger-php

php /Users/DC/www/yii2/vendor/zircote/swagger-php/bin/swagger /Users/DC/www/yii2/vendor/zircote/swagger-php/Examples -o /Users/DC/www/yii2/swagger-docs

"-o" 前面代表API源目录, 即你想要生成哪个目录的API文档, 你的项目代码目录. "-o" 后面是生成到哪个path

目标目录会产生一个swagger.json的文件，这个文件放到前端dist/index.html中可以访问的地方即可

 

然后再看http://localhost/yii2/swagger-ui/dist/index.html, 生成了API文档

准备工作都做好了, 那就写代码注释就行了, 注释怎么写? 参考官方文档http://zircote.com/swagger-php/annotations.html