博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
用Swagger生成接口文档
阅读量:5812 次
发布时间:2019-06-18

本文共 458 字,大约阅读时间需要 1 分钟。

Swagger简介

在系统设计的时候,各个应用之间往往是通过接口进行交互的。因此接口的定义在整个团队中就变得尤为重要。我们可以把接口的规范用接口描述语言进行描述,然后Swagger可以根据我们定义的接口规范生成对应的接口文档。它生成的接口文档提供了接口测试功能。我们只需要填上对应的参数,然后点击调用,就可以完成一次接口测试,非常方便。就像下图展示的那样。

 

不仅如此,Swagger还能够根据接口规范自动生成对应的接口代码!比如Java客户端代码、Java服务端代码等。这个东西减少了接口规范的沟通成本,让开发人员能够直奔主题进行编码。开发人员甚至都不需要写客户端的代码了,只需要实现服务端代码即可。

Swagger使用方法

首先,打开Swagger的编辑器。通过网页也可以打开:http://editor.swagger.io/。打开之后是下图这样,按照它给的格式就可以写出接口文档啦~

 

小结

Swagger节省了开发人员的时间。只需编写一次接口规范,就可以多次使用。用程序员的话来讲就是提高了接口规范的可复用性。

 

转载地址:http://ehvbx.baihongyu.com/

你可能感兴趣的文章
js之无缝滚动
查看>>
17位女性科学家带你预测2017和2027
查看>>
Django 多表联合查询
查看>>
Freebsd系统故障导致系统不能正常启动的恢复数据方法[图]
查看>>
logging模块学习:basicConfig配置文件
查看>>
Golang 使用 Beego 与 Mgo 开发的示例程序
查看>>
DHCP服务器数据备份以及还原
查看>>
ntpdate时间同步
查看>>
Asp.Net MVC 插件化开发简化方案
查看>>
LH乱码转换
查看>>
+++++++子域授权与编译安装(一)
查看>>
编程修养(七)
查看>>
asp.net怎样在URL中使用中文、空格、特殊字符
查看>>
ISA2006实战系列之二:实战ISA三种客户端部署方案(下)
查看>>
Linux后门入侵检测工具,附bash漏洞最终解决方法
查看>>
ASA5585-S20测试方案
查看>>
利用for循环打印实心棱形和空心棱形
查看>>
路由器发布服务器
查看>>
实现跨交换机VLAN间的通信
查看>>
oracle import & export 操作相关脚本
查看>>