初识 Swagger

什么是Swagger:

     Swagger是一个规范完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端文件系统作为服务器以同样的速度来更新。接口的方法,参数和模型紧密集成到服务端的代码,允许API来始终保持同步。Swagger让部署管理和使用功能强大的API从未如此简单。

     在实际开发过程,我们的RESTfulAPI就有可能要面对多个开发人员或者多个开发团队:IOS开发、Android开发、Web开发。为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTful文档来记录所有接口细节,然而这样的做法有以下几个问题:

》》》由于接口众多,并且细节复杂(需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等)

》》》随着时间的推移,不断地修改接口实现地时候都必须同步修改接口文档,而文档与代码又处于两个不同地媒介,除非有严格的管理机制,不然很容易导致不一致现象

    而swagger完美的解决了上面的几个问题,并与Spring boot程序配合组织出强大的RESTful API文档。它既可以减少我们创建文档的工作量,同时说明内容又整合入实现代码中,让维护文档和修改代码整合为一体,可以让我们修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能,来调试每个RESTful API

    

posted @ 2019-08-29 16:03  XIAOFANOoO  阅读(108)  评论(0编辑  收藏  举报