swagger2和swagger3的配置以及常用注解说明

一、swagger2

1. 我的相关依赖

	        <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>io.github.swagger2markup</groupId>
	            <artifactId>swagger2markup</artifactId>
	            <version>1.3.3</version>
	        </dependency>

2. 配置类

import io.swagger.annotations.ApiOperation;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@ConditionalOnClass(MediaType.class)
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket creatRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();

    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("配置查询接口API文档")
                .contact(new Contact("pudding","","pudding@qq.com"))
                .version("1.0")
                .build();
    }
}

3. url：http://localhost:7082/swagger-ui.html#/ （7082是端口号）

二、swagger3

1. 我的相关依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

2. 配置类

import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Component
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                //        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .apis(RequestHandlerSelectors.basePackage("com.daqo.cloud.xformer.board.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("配置查询接口API文档")
                .contact(new Contact("pudding","","pudding@qq.com"))
                .version("1.0")
                .build();
    }
}

3. url：http://localhost:7082/swagger-ui/#/（7082是端口号）

4.关闭swagger3

在properties配置文件中增加配置：
	springfox.documentation.swagger-ui.enabled=false

三、常用注解说明

1. @Api：用在请求的类上，说明该类的作用

       参数：
        tags：说明这个类的作用
    	value：这个参数没有什么意义，不需要配置
   

2. @ApiOperation：用在请求的方法上，说明方法的作用

       参数：
       value：说明方法的作用
    	notes：方法的备注说明
   

3. @ApiImplicitParams和@ApiImplicitParam，和@ApiParam

   （1） @ApiImplicitParams：用在请求的方法上，包含一组参数说明
   （2）@ApiImplicitParams：用在 @ApiImplicitParams 注解中，指定一个请求参数的配置信息
    		参数：
    			name：参数名
    			
    			value：参数的汉字说明、解释
    			
    			required：参数是否必须传
    			
    			paramType：参数放在哪个地方
       				 · header --> 请求参数的获取：@RequestHeader
       				 · query --> 请求参数的获取：@RequestParam
       				 · path（用于restful接口）--> 请求参数的获取：@PathVariable
      				  · body（不常用）
      				  · form（不常用） 
      				     
    			dataType：参数类型，默认String，其它值dataType="Integer"     
    			  
   			defaultValue：参数的默认值
   				
   （3）@ApiParam：用在方法参数里，指定对应请求参数的配置信息
   

4. @ApiModel和@ApiModelProperty

    （1）@ApiModel：用于响应类上，表示一个返回响应数据的信息
        （这种一般用在post创建的时候，使用@RequestBody这样的场景，
        请求参数无法使用@ApiImplicitParam注解进行描述的时候）
        
    （2）@ApiModelProperty：用在属性上，描述响应类的属性
   

   

5. @ApiResponses和@ApiResponse

    （1）@ApiResponses：用于请求的方法上，表示一组响应
    
    （2）@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
   			 code：数字，例如400
   			 message：信息，例如"请求参数没填好"
   			 response：抛出异常的类
   

   @ApiOperation(value = "select1请求",notes = "多个参数，多种的查询参数类型")
   @ApiResponses({
       @ApiResponse(code=400,message="请求参数没填好"),
       @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
   })
   

四、结果展示