SpringBoot整合Swagger2接口文档

Java光头强 • 2023年2月20日下午4:02 • 后端笔记 • 阅读 199

一、添加依赖

<!-- 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>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

二、添加配置

在我们的application.yaml 添加配置

swagger:
  title: xxx项目RESTful API
  description: 开发人员太懒，没有写描述
  version: 1.0
  contactName: lxt
  contactEmail:
  contactUrl:
  basePackageRest: com.qcby.xxx.rest
  termsOfServiceUrl:

在我们的config配置包下添加SwaggerProperties.java文件

@Component
@ConfigurationProperties(prefix = "swagger")
@Data
public class SwaggerProperties {
    private String title;
    private String contactName;
    private String contactUrl;
    private String contactEmail;
    private String version;
    private String description;
    private String basePackageRest;
    private String termsOfServiceUrl;

}

再建立SwaggerConfig.java

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Autowired
    private SwaggerProperties swaggerProperties;

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("REST接口8000")
                .apiInfo(apiInfo())
                .select()
                //  配置自动扫描那些包下类型生成接口文档
                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackageRest()))
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title(swaggerProperties.getTitle())
                //创建人
                .contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(),swaggerProperties.getContactEmail()))
                //版本号
                .version(swaggerProperties.getVersion())
                //描述
                .description(swaggerProperties.getDescription())
                .build();
    }
}

另外其他类中的注解加方法

//  controller类
@Api(value = "通用接口", tags = {"通用接口"})


// 方法
@ApiOperation("演示接口")

// 参数
@ApiImplicitParams(
    {@ApiImplicitParam(name = "Authorization", 
        value = "Authorization token", required = true, 
        dataType = "string", paramType = "header")}
        )
// 实体类  
@ApiModel("用户实体")       
// 实体类字段
@ApiModelProperty(value = "创建时间")

拦截器不拦截接口文档（拦截则需要登录后可以登录）

如果需要不登陆即可访问，才需要配置（可选）

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(loginInterceptor()).addPathPatterns("/**")
            // 那些路径不拦截
            .excludePathPatterns("/login/**","/error"
            ,"/swagger-ui.html/**","/swagger-resources/**");
}