Swagger与Knife4j知识概括
Swagger与Knife4j知识概括
前后端分离简介:
- 前后端职责:
①前端 -> 前端控制层、视图层
②后端 -> 后端控制层、服务层、数据访问层
- 前后端描述:
①前后端通过API进行交互
②前后端相对独立且松耦合
- 产生的问题:前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最终导致问题集中爆发
- 解决方案:定义schema [ 计划的提纲 ],并实时跟踪最新的API,降低集成风险
- 链接:动态生成最新版本API文档的服务器
Swagger简介:
- 号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
直接运行,在线测试API
- 支持多种语言 (如:Java,PHP等)
- 链接:swagger官网
- 相较于传统的Postman或Curl方式测试接口,使用swagger简直就是傻瓜式操作,不需要额外说明文档(写得好本身就是文档)而且更不容易出错,
只需要录入数据然后点击Execute,如果再配合自动化框架,可以说基本就不需要人为操作了。
- Swagger是个优秀的工具,现在国内已经有很多的中小型互联网公司都在使用它,相较于传统的要先出Word接口文档再测试的方式,显然这样也更符合现在的快速迭代开发行情。当然了,
提醒下大家在正式环境要记得关闭Swagger,一来出于安全考虑二来也可以节省运行时内存。
Swagger使用
使用Swagger:
- 要求:jdk 1.8 + 否则swagger2无法运行
- 添加Maven依赖
<!-- swagger核心jar包-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- swagger界面jar包-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
- 使用Swagger需要编写一个配置类来配置 Swagger
@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}
- 访问
http://localhost:8080/swagger-ui.html
可以看到swagger的界面。
配置Swagger:
Swagger实例Bean是Docket
,所以通过配置Docket实例来配置Swaggger。
@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2);
}
可以通过apiInfo()属性配置文档信息
//配置文档信息
private ApiInfo apiInfo() {
Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
return new ApiInfo(
"Swagger学习", // 标题
"学习演示如何配置Swagger", // 描述
"v1.0", // 版本
"http://terms.service.url/组织链接", // 组织链接
contact, // 联系人信息
"Apach 2.0 许可", // 许可
"许可链接", // 许可连接
new ArrayList<>()// 扩展
);
}
Docket 实例关联上apiInfo()
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}
配置扫描接口:
构建Docket时通过select()方法配置怎么扫描接口。
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
.apis(RequestHandlerSelectors.basePackage("com.george.swagger.controller"))
.build();
}
----------