在工作过程中会接触到API文档,所以自然会接触的Swagger接口文档神奇啦,可能有的公司用的不一样吧,下面是简单了解接触Swagger的笔记。
1、了解Swagger
(1)swagger的整体认知
解决接口规范化、标准化、文档化的开源库:易用+免费+开源
Swagger是一款接口文档的在线生产软件、接口的功能测试软件、前后端开发沟通的桥梁
根据接口定义动态生成在线文档,并支持在线测试的一款软件
将项目中所有的接口展示在页面上,并且在页面上可以进行简单的调用和测试功能
(2)Swagger能解决的问题
解决后端开发者WIKI的维护问题
解决前端和后端开发者的沟通问题
提高测试开发者的效率问题
对有些接口没有前端页面的,可以直接在swagger操作接口进行测试
(3)swagger的基础知识(swagger是建立在Java的语法基础上的)
Java的基础语法知识
Spring Boot的基础知识
Swagger的基础知识
(4)Swagger工具
Swagger Editor - 开源编辑器
Swagger UI - 呈现可交互在线文档
Swagger Codegen - 生成调用代码的工具
2、Swagger的简单搭建和使用
(1)swagger注解
(2)swagger搭建
(3)swagger在线测试(简单)
(4)swagger使用注意事项
(5)swagger其他
3、初识Swagger的总结
(1)swagger的本质
(2)swagger的作用
(3)swagger的拓展领域
4、后续的进阶……
未完待续……