首先、下载swagger-php包
在你的项目里安装composer(不过最好全局安装composer)
然后在你的项目任何位置,执行下面命令(Mac或Linux系统,window系统可以查看相应的composer命令)
composer require zircote/swagger-php
我们使用的是zircote的swagger包
第二、生成接口文档(json格式)
包下载好之后,在当前目录执行以下命令
php ./vendor/zircote/swagger-php/bin/swagger 需要生成接口文档的mvc目录 -o 接口文档生成位置
你也可以在你的mvc目录下,增加一个swagger-config.php配置文件(命名可修改),里面可以设置好基本配置(仅列出基本配置,详细配置请参考swagger文档)
此时你就可以在你项目的Controller文件中添加详细swagger接口注释了,每次修改完成之后,执行一下上面的命令即可生成接口文档json
第三、展示json
生成接口文档之后,就需要对外展示了,这里我们使用官方提供的swagger-ui,大家有兴趣也可以试试其他swagger-ui扩展,做的也不错。
在你项目对外访问的目录,执行下面命令
git clone https://github.com/swagger-api/swagger-ui.git
执行完毕之后,你的项目就会有一个swagger-ui文件夹,修改文件夹中的dist/index.html第77行
url: "/docs/swagger.json",
把url指向上面命令的 接口文档生成位置 即json生成位置
保存
打开浏览器,访问
你的域名/swagger-ui/dist
这样就ok了。