springboot配置swagger2

引入依赖

		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
         	<version>30.1.1-jre</version> 
        </dependency>

启动配置

@Configuration
@ConditionalOnExpression("'${spring.profiles.active}'.equals('dev')") // 只有dev环境下启用
@EnableSwagger2
public class SwaggerConfig {

	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(true).select().build();
	}

	@Bean
	public ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("XX报告API").description("XX报告API").version("1.0").build();
	}
}

实体类注解

@ApiModel("XXXX")
@ApiModelProperty(value = "id", example = "添加时不需要指定，修改时需要指定")

Controller类注解

@ApiModel("季度绩效职位指标配置")

方法注解

@ApiOperation(value = "增加客户信息")
@ApiImplicitParam(name = "phone", value = "手机号", dataType = "String", paramType = "query")
@ApiImplicitParams(value = {
			@ApiImplicitParam(name = "phone", value = "手机号", dataType = "String", paramType = "query"),
			@ApiImplicitParam(name = "code", value = "验证码", dataType = "String", paramType = "query") })