本文共 2498 字，大约阅读时间需要 8 分钟。

引入maven

           
    
     2.9.2
        
   
           
               
    
     io.springfox
                
    
     springfox-swagger2
                
    
     ${swagger2.version}
            
           
               
    
     io.springfox
                
    
     springfox-swagger-ui
                
    
     ${swagger2.version}
            
   

配置config

package com.isstech.safety.alarm.config;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.ParameterBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.schema.ModelRef;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Parameter;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;import java.util.ArrayList;import java.util.List;/** * @description SwaggerConfig * * @author china * @date 2021-02-20 10:20 */@Configuration@EnableSwagger2public class SwaggerConfig {
       @Bean    public Docket createRestApi(){
           // 添加请求参数，token请求头部参数传入后端        ParameterBuilder parameterBuilder = new ParameterBuilder();        List
   
     parameters = new ArrayList
    
     ();        parameterBuilder.name("token").description("token")                .modelRef(new ModelRef("string")).parameterType("header").required(false).build();        parameters.add(parameterBuilder.build());        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()                .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any())                .build().globalOperationParameters(parameters);        // 不加参数//        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//                .select()//                .apis(RequestHandlerSelectors.any())//                .paths(PathSelectors.any()).build();    }    private ApiInfo apiInfo(){
           return new ApiInfoBuilder()                .title("系统 API 文档")                .description("This is a restful api document of smart watter.")                .version("1.0")                .build();    }}
    
   

使用

// 类中加@Api(tags = "告警")// 方法中加@ApiOperation("获取数据类型进行的统计")// 参数中加@ApiParam(value = "主键")@RequestParam(required = false) String id

转载地址：https://openai.blog.csdn.net/article/details/113765244 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！