初识Swagger
-
号称世界上最流行的API框架
-
Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
-
直接运行,在线测试API
-
支持多种语言 (如:Java,PHP等)
-
官网:https://swagger.io/
Swagger作为一个框架,我们需要引入第三方jar包,并且在springboot中进行配置,才可以基于他们的语法来使用他们的功能
配置
引入依赖
-
swagger2:swagger2的功能包
-
swagger-ui:swagger的可视化界面
<!-- swaggerUI -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
开启配置
- 配置swagger,需要新建一个配置类,并且为这个配置类用@EnableSwagger2注解开启swagger自动配置。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
}
注册分组
- Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2).groupName("分组一"