快捷導(dǎo)航

springboot swagger 接口文檔分組展示功能實(shí)現(xiàn)

更新時(shí)間：2024年03月27日 10:14:01 作者：狄龍疤

這篇文章主要介紹了springboot swagger 接口文檔分組展示功能實(shí)現(xiàn),本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧

例如將 controller 分成四類，分別放到四個(gè)包下：

        
xxx.xxx.xxx.controller.manage
xxx.xxx.xxx.controller.client
xxx.xxx.xxx.controller.authority
xxx.xxx.xxx.controller.common

SwaggerConfig.java：

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
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.Contact;
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.Collections;
import java.util.List;
@RefreshScope
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Value("${system.swagger_show}")
    private boolean swaggerShow;
     @Bean
    public Docket manageGroup() {
        return this.buildDocket( "管理端接口","xxx.xxx.xxx.controller.manage" );
    }
    @Bean
    public Docket clientGroup() {
        return this.buildDocket( "移動(dòng)端接口","xxx.xxx.xxx.controller.client" );
    }
    @Bean
    public Docket authorityGroup() {
        return this.buildDocket( "權(quán)限相關(guān)接口","xxx.xxx.xxx.controller.authority" );
    }
    @Bean
    public Docket commonGroup() {
        return this.buildDocket( "數(shù)據(jù)字典、行政區(qū)域公共接口","xxx.xxx.xxx.controller.common" );
    }
    private Docket buildDocket( String groupName,String basePackage ){
        return new Docket(DocumentationType.SWAGGER_2)
                    .groupName( groupName )
                    .enable(this.swaggerShow)
                    .produces(Collections.singleton(MediaType.APPLICATION_JSON_VALUE))
                    .genericModelSubstitutes(ResponseEntity.class)
                    .forCodeGeneration(false)
                    .useDefaultResponseMessages(false)
                    .pathMapping("/")
                    .select()
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .apis(RequestHandlerSelectors.basePackage( basePackage ))
                    .paths(PathSelectors.any())
                    .build()
                    .globalOperationParameters( setHeaderToken() )
                    .directModelSubstitute(java.sql.Timestamp.class, java.sql.Date.class)
                    .apiInfo(apiInfo());
    }
    private List<Parameter> setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("witToken").description("登錄token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
        return pars;
    }
    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("xxx系統(tǒng)( xxx) API")
                .description("xxx系統(tǒng)( xxx) API")
                .license(null)
                .licenseUrl(null)
                .contact(new Contact("developer", "", "developer@xxx.com"))
                .version("1.0")
                .build();
        return apiInfo;
    }
}

效果：