Swagger的使用

Swagger的使用

1. 介绍：Swagger你只需要按照你的需求定义接口及接口或实体类的相关信息，在通过Swagger生成一系列项目工具，就可做到生成接口文档方方便前端进行调试

2. 导入依赖

      <dependency>
               <groupId>com.github.xiaoymin</groupId>
               <artifactId>knife4j-spring-boot-starter</artifactId>
               <version>3.0.2</version>
           </dependency>
   
   

3. 在WebConfig中进行配置

  @Bean
    public Docket createRestApi() {
        // 文档类型
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.liu.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目名")
                .version("1.0")
                .description("描述")
                .build();
    }

4. 如果是security项目需要配置放行

5. 启动项目后访问doc.html即可访问

6. 常用注解

   注解	说明
   @ApiModel	用在类上，通常是实体类，表示一个响应数据的新信息
   @Api	用在请求的类上，表示对类的说明
   @ApiModelProperty	用在属性上，描述响应类的属性
   @ApiOperation	用在请求方法上，表示一方法的用途和作用
   @ApilmplicitParams	用在请求方法上，表示一组参数说明
   @ApilmplicitParam	用在@ApilmplicitParams注解中，指定一个请求参数的各个方面