上一篇讲解了如是使用YAML语法编写api说明文档
文档编写好之后,是要给开发人员看的,尤其是前端开发人员
为当前创建虚拟目录(当然也不可以不创建,放在www目录下即可),然后修改 hosts 文件
<VirtualHost _default_:80> DocumentRoot "D:/phpStudy/PHPTutorial/WWW/tpswagger/public" ServerName simple.cn ServerAlias malladmin.alima.cn <Directory "D:/phpStudy/PHPTutorial/WWW/tpswagger/public"> Options -Indexes -FollowSymLinks +ExecCGI AllowOverride All Order allow,deny Allow from all Require all granted </Directory> </VirtualHost>
在项目的public 目录下,新建一个文件 swagger,然后回到 swagger editor 的在线编辑界面,按如下操作到处json文件
将导出的json文件拷贝到上卖弄的swagger 目录下
打开swagger-ui 目录下的 index.html,修改 url 属性的路径为导出的swagger.json
在浏览器中输入如下地址,访问这个index.html 文档
http://simple.cn/swagger-ui/index.html
下面是不完全截图
以一种非常友好的方式展示了所有的api,展开api可以看到详细信息,还可以测试api