转载

发表于 2019年04月07日
浏览 (875)
评论 (0)

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

正文到此结束

所属分类：软件架构编程技术

本文标签： js json PHP API http https Document 目录 IDE src 测试 HTML UI root CTO id 开发 VirtualHost SDN IO
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

热门推荐

配置虚拟站点

浏览(8,965) 评论(20)
修改上传文件权限

浏览(10,736) 评论(18)
VPS 自我监控

浏览(9,458) 评论(23)
OpenVZ VPS 额外支持

浏览(9,498) 评论(17)
openfire数据库安装指南

浏览(19,080) 评论(0)
openfire定制指南

浏览(10,597) 评论(17)
Caffe 深度学习框架上手教程

浏览(14,980) 评论(0)
ReactiveCocoa入门教程：第一部分

浏览(15,755) 评论(0)
开源HIDS-OSSEC使用实例:监测CC攻击

浏览(15,681) 评论(0)
Decorators in ES7

浏览(20,327) 评论(4)

相关文章

阿里云首购8折

Loading...

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

[HBLOG]公众号

HBLOG

HBLOG