TP5集成Swagger编写API文档(三)

上一篇讲解了如是使用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文件

TP5集成Swagger编写API文档(三)

将导出的json文件拷贝到上卖弄的swagger 目录下

打开swagger-ui 目录下的 index.html,修改 url 属性的路径为导出的swagger.json

TP5集成Swagger编写API文档(三)

在浏览器中输入如下地址,访问这个index.html 文档

http://simple.cn/swagger-ui/index.html

下面是不完全截图

TP5集成Swagger编写API文档(三)

以一种非常友好的方式展示了所有的api,展开api可以看到详细信息,还可以测试api

原文 

https://blog.csdn.net/mynewdays/article/details/89066592

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » TP5集成Swagger编写API文档(三)

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址