文章目录
引言
后端修改了接口,需要手动维护api文档,加大了开发的工作量和困难,而swagger的出现就是为了解决这一系列的问题。
swagger是一套基于OpenAPI规范构建的开源工具,使用RestApi
- 代码变,文档变
- 跨语言,支持多种语言
- swagger-ui 呈现出来的是一份可交互式的API文档,可以直接在文档页面尝试API的调用
- 可以将文档规范导入相关工具(postman、soapui),这些工具将会为我们自动地创建自动化测试
RestApi格式是根据请求的方式决定本次请求的一个操作,譬如:get–>读,post–>写(增、删、改),put–>修改,delete–>删除。https://www.ibm.com/cn-zh/cloud/learn/rest-apis
OpenApi与语言无关,只是一种规范,可以使用yaml和json格式进行编写,这样更利于我们和机器进行阅读