当前位置: 首页 > Web前端 > HTML

Swagger入门

时间:2023-03-28 12:31:49 HTML

缘起无论是前端开发还是后端开发,都或多或少被接口文档折磨过。前端经常抱怨后端给的接口文档与实际不符。后端感觉编写和维护接口文档会消耗很多精力,很多时候来不及更新。其实不管是前端调用后端还是后端调用后端,我们都期待一个好的接口文档。简介Swagger是一个标准化的完整框架,用于生成、描述、调用和可视化RESTfulWeb服务。Swagger的目标是为RESTAPI定义一个标准的和语言中立的接口,让人们和计算机能够在不访问源代码、文档或网络流量监控的情况下发现和理解服务。通过Swagger正确定义后,用户可以使用最少的实现逻辑理解远程服务并与之交互。与为低级编程实现的接口类似,Swagger消除了调用服务时的猜测。后台人员无需关注Swagger描述文件和接口文档。如果有需求变更导致接口变更,直接写代码即可。修改调用层的代码,然后生成新的描述文件和接口文档,然后发送给前端。真是一劳永逸。实现代码和接口文档的流程一致优势支持API自动生成同步在线文档:使用Swagger后,可以直接通过代码生成文档,不再需要自己手动编写接口文档。对程序员来说非常方便,可以节省写Documentation的时间来学习新技术。提供网页在线测试API:Swagger生成的文档也支持在线测试。参数和格式都设置好了,直接在界面上输入参数对应的值就可以在线测试界面了。