- 加入依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
- 配置swagger
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("cn.test.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("测试-练习工程")
.version("1.0.1")
.description("测试swagger")
.build();
}
}
- 启用swagger
@EnableSwagger2
@SpringBootApplication
public class XxxApplication {
public static void main(String[] args) {
SpringApplication.run(XxxApplication.class, args);
}
}
- 以下三个方法均为重写 RequestHandlerSelectors 中的 3 个方法,使之支持多包扫描,如果重写了以下3个方法,则需要覆盖掉SwaggerConfig配置中的RequestHandlerSelectors.basePackage(“cn.test.controller”)改为有以下方法扫描
private static Predicate<RequestHandler> basePackage(final String basePackage) {
return input -> (Boolean) declaringClass(input)
.transform(SwaggerConfig.handlerPackage(basePackage)).or(true);
}
private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) {
return input -> {
for (String strPackage : basePackage.split(",")) {
boolean isMatch = ClassUtils.getPackageName(input).startsWith(strPackage);
if (isMatch) {
return true;
}
}
return false;
};
}
private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
return Optional.fromNullable(input.declaringClass());
}
swagger注解
swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。
- @Api:修饰整个类,描述Controller的作用
- @ApiOperation:描述一个类的一个方法,或者说一个接口
- @ApiParam:单个参数描述
- @ApiModel:用对象来接收参数
- @ApiProperty:用对象接收参数时,描述对象的一个字段
- @ApiResponse:HTTP响应其中1个描述
- @ApiResponses:HTTP响应整体描述
- @ApiIgnore:使用该注解忽略这个API
- @ApiError :发生错误返回的信息
- @ApiImplicitParam:一个请求参数
- @ApiImplicitParams:多个请求参数
- @Api:修饰整个类,描述Controller的作用
- @Api:用在请求的类上,表示对类的说明
- tags=“说明该类的作用,可以在UI界面上看到的注解”
- value=“该参数没什么意义,在UI界面上也看到,所以不需要配置”
- @ApiOperation:用在请求的方法上,说明方法的用途、作用
- value=“说明方法的用途、作用”
- notes=“方法的备注说明”
- @ApiImplicitParams:用在请求的方法上,表示一组参数说明
- @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
- name:参数名
- value:参数的汉字说明、解释
- required:参数是否必须传
- paramType:参数放在哪个地方
- header --> 请求参数的获取:
- @RequestHeader· query --> 请求参数的获取:
- @RequestParam· path(用于restful接口)–> 请求参数的获取:
- @PathVariable· body(不常用)
- form(不常用)
- dataType:参数类型,默认String,其它值dataType=“Integer”
- defaultValue:参数的默认值
- @ApiResponses:用在请求的方法上,表示一组响应
- @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
- code:数字,例如400message:信息,例如"请求参数没填好"response:抛出异常的类
- @ApiModel:用于响应类上,表示一个返回响应数据的信息
- (这种一般用在post创建的时候,使用@RequestBody这样的场景,
- 请求参数无法使用@ApiImplicitParam注解进行描述的时候)
- @ApiModelProperty:用在属性上,描述响应类的属性