Swagger是一个规范和完整的框架,用于生成,描述,调用和可视化Restful风格的web服务
总体目标是使用客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数
和模型密集成到服务器的代码,允许API来始终保持同步
为啥我们要使用Swagger?
因为前后端分离了,前端和后端的工作不同的工程师完成,在这种开发模式下
维持一份及时更新且完整的RestAPI文档会极大提高我们的工作效率。传统意义上的文档
都是后端开发人员手动编写的,这种方式很难保证文档的及时性,这种文档时间久了
就会市区参考意义,反而加大沟通成本。swagger提供了全新的Api文档维护方式
作为后端开发人员,最烦人的事情就是自己写的文档别人没有写接口文档,不管前端还是 后端,swagger可以较好的接口接口文档的交互问题,用一套标准的规范定义接口以及相 关信息,能够做到生成各式各样的接口文档,生成多种语言和客户端的代码,以及在线接 口调试,只需要更新Swagger描述文件,就可以自动生成接口文档,做到前端后端链接接 口文档的及时性和便利性。
作用:1,支持API自动生成同步的在线文档:使用Swagger后可以直接通过代码生成文档,不再需要自 己动手编写接口文档。
2,提供Web页面在线测试Api:Swagger生成的文档支持在线测试。参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口。