SpringBoot整合Swagger3生成接口文档



SpringBoot整合Swagger3生成接口文档

  1. pom文件中引入Swagger3依赖

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    <!-- Swagger3依赖 -->
    <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
    </dependency>
    <!-- 接口API生成html文档 -->
    <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
    </dependency>
  2. Application上面加入@EnableOpenApi注解

    1
    2
    3
    4
    5
    6
    7
    @EnableOpenApi
    @SpringBootApplication
    public class Swagger3Application {
    public static void main(String[] args) {
    SpringApplication.run(Swagger3Application.class, args);
    }
    }
  3. Swagger3的配置

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    /**
    * Swagger3Config配置类
    * @author coderblue
    */
    @Configuration
    public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
    return new Docket(DocumentationType.OAS_30)
    .apiInfo(apiInfo())
    .select()
    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
    .paths(PathSelectors.any())
    .build();
    }

    private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
    .title("Swagger3接口文档")
    .description("SpringBoot整合Swagger3生成接口文档")
    .contact(new Contact("coderblue。", "https://www.coderblue.cn", ""))
    .version("1.0")
    .build();
    }
    }
  4. Swagger注解的使用说明

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    @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:数字,例如400
    message:信息,例如"请求参数没填好"
    response:抛出异常的类

    @ApiModel:用于响应类上,表示一个返回响应数据的信息
    (这种一般用在post创建的时候,使用@RequestBody这样的场景,
    请求参数无法使用@ApiImplicitParam注解进行描述的时候)
    @ApiModelProperty:用在属性上,描述响应类的属性
  5. 效果如图所示:访问 127.0.0.1:port端口号/swagger-ui/index.html

  6. 如果想使用Swagger2,那么只要更换依赖和配置即可

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    @Configuration//配置类
    @EnableSwagger2 //swagger注解
    public class Swagger2Config {

    @Bean
    public Docket webApiConfig(){
    return new Docket(DocumentationType.SWAGGER_2)
    .groupName("webApi")
    .apiInfo(webApiInfo())
    .select()
    .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
    .paths(Predicates.not(PathSelectors.regex("/error.*")))
    .build();

    }

    private ApiInfo webApiInfo(){

    return new ApiInfoBuilder()
    .title("网站-课程中心API文档")
    .description("本文档描述了课程中心微服务接口定义")
    .version("1.0")
    .contact(new Contact("java", "https://coderblue.cn", "coderbleu@gmail.com"))
    .build();
    }
    }

    // Swagger2依赖
    <!-- &lt;!&ndash;添加Swagger2依赖 &ndash;&gt;-->
    <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>
打赏
  • 版权声明: 本博客所有文章除特别声明外,均采用 Apache License 2.0 许可协议。转载请注明出处!
  1. © 2020-2021 Lauy    湘ICP备20003709号

请我喝杯咖啡吧~

支付宝
微信