用Swagger生成接口文档

Swagger简介

在系统设计的时候，各个应用之间每每是经过接口进行交互的。所以接口的定义在整个团队中就变得尤其重要。咱们能够把接口的规范用接口描述语言进行描述，而后Swagger能够根据咱们定义的接口规范生成对应的接口文档。它生成的接口文档提供了接口测试功能。咱们只须要填上对应的参数，而后点击调用，就能够完成一次接口测试，很是方便。就像下图展现的那样。

 

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

Swagger使用方法

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

 

小结

Swagger节省了开发人员的时间。只需编写一次接口规范，就能够屡次使用。用程序员的话来说就是提升了接口规范的可复用性。