swagger实战使用

关注

原创最新推荐文章于 2026-08-12 08:26:08 发布 2.2w 阅读 AI 写同款· GEO 优化 ›

实战项目-SwaggerUI使用 https://www.cnblogs.com/jockming/p/12233433.html 1：认识Swagger Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。作用： 1. 接口的文档在线自动生成。 2. 功能测试。 Swagger是一组开源项目，其中主要要项目如下： Swagger-tools:提阅读详情

引入依赖项,以下是gradle版本的libraries.gradle依赖文件的

ext {
    versions = [
            springFoxSwagger2: '2.9.2'
    ]

    libraries = [
            /**swagger**/
            swagger_bootstrap_ui          : "com.github.xiaoymin:swagger-bootstrap-ui:1.9.3",
            springfox_swagger2            : "io.springfox:springfox-swagger2:${versions.springFoxSwagger2}",
            springfox_swagger2_ui         : "io.springfox:springfox-swagger-ui:${versions.springFoxSwagger2}",
    ]
}

配置文件 application.yml 配置swagger开关

#swagger接口文档开关
swagger:
  enable: true
customer:
  env: TEST

swagger配置类

@EnableSwagger2
public class SwaggerConfig {

  @Bean
  public Docket createRestApi(@Value("${swagger.enable}") Boolean enable) {
    return new Docket(DocumentationType.SWAGGER_2)
        .genericModelSubstitutes(DeferredResult.class)
        .apiInfo(testApiInfo())
        .select()
        .apis(Predicates.or(
            RequestHandlerSelectors.withMethodAnnotation(TestDoc.class)
            , RequestHandlerSelectors.withClassAnnotation(TestDoc.class)
        ))
        .paths(PathSelectors.any())
        .build()
        .enable(enable);
  }

  private ApiInfo testApiInfo() {
    return
        new ApiInfo(
            "测试中心接口",
            "测试中心接口",
            "1.0.0",
            "API TERMS URL",
            new Contact("title", "", ""),
            "© 2021 title",
            "license url",
            new ArrayList<>());
  }
}

Doc

import org.springframework.stereotype.Component;
import java.lang.annotation.*;


@Target({ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface TestDoc {

}