`

swagger2的分组配置

 
阅读更多
当微服务的服务越来越多swagger2展示的越来越长这时候需要进行分页展示
swagger2头上有下拉框可以groupName进行分组展示

java代码代码:

@Configuration
@EnableSwagger2
public class SwaggerConfig {

@Bean
    public Docket createRestApi() {


        return new Docket(DocumentationType.SWAGGER_2)
        .globalOperationParameters(operationParameters())
        .groupName("第一个接口服务页面")
        .genericModelSubstitutes(DeferredResult.class)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.tan.oauth2.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(" createRestApi  Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多Spring Boot相关文章请关注:http://blog.didispace.com/")
                .termsOfServiceUrl("http://github.com/")
                .contact("程序猿痛苦")
                .version("1.0")
                .build();
    }
    @Bean
    public Docket openRestApi() {
    Predicate<RequestHandler> predicate = new Predicate<RequestHandler>() {
            @Override
            public boolean apply(RequestHandler input) {
//                 Class<?> declaringClass = input.declaringClass();
//                 if (declaringClass == BasicErrorController.class)// 排除
//                     return false;
//                 if(declaringClass.isAnnotationPresent(ApiOperation.class)) // 被注解的类
//                     return true;
//                 if(input.isAnnotatedWith(ResponseBody.class)) // 被注解的方法
//                     return true;
//                 if (input.isAnnotatedWith(ApiOperation.class))//只有添加了ApiOperation注解的method才在API中显示
//                     return true;
                if (input.isAnnotatedWith(ApiOperation.class))//只有添加了ApiOperation注解的method才在API中显示
                return true;
                return false;
            }
        };
    return new Docket(DocumentationType.SWAGGER_2)
    .groupName("第二个接口服务页面")
    .genericModelSubstitutes(DeferredResult.class)
    .apiInfo(openapiInfo())
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.tan.oauth2.controller2"))
//     .apis(predicate)
    .paths(PathSelectors.any())
    .build();
    }
    private ApiInfo openapiInfo() {
    return new ApiInfoBuilder()
    .title("openRestApi Spring Boot中使用Swagger2构建RESTful APIs")
    .description("更多Spring Boot相关文章请关注:http://blog.didispace.com/")
    .termsOfServiceUrl("http://github.com/")
    .contact("程序猿痛苦")
    .version("1.0")
    .build();
    }
   
    public  List<Parameter> operationParameters() {
    //添加head参数start
    ParameterBuilder tokenPar = new ParameterBuilder();
    List<Parameter> pars = new ArrayList<Parameter>();
    tokenPar.name("x-access-token")
    .description("令牌")
    .modelRef(new ModelRef("string"))
    .parameterType("header")
    .required(false)
    .build();
    pars.add(tokenPar.build());
    //添加head参数end
    return pars; 
    }
   
}

pom.xml文件配置

                 <dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>


分享到:
评论

相关推荐

    swagger+springboot配置

    Swagger 是一个流行的API开发工具,它提供了一套强大的文档化和测试框架,使得开发者能够轻松地构建RESTful API。...在实际项目中,还可以根据需求进一步定制Swagger的配置,如添加自定义模型、分组API等。

    SpringMVC 集成 Swagger2

    创建一个`Swagger2Config`配置类,通过`@EnableSwagger2`注解启用Swagger2。在类中定义一个`Docket`对象,设置API的基本信息,如版本、分组、描述等。例如: ```java @Configuration @EnableSwagger2 public class ...

    SpringBoot整合Swagger2

    5. **增强Swagger2**:除了基本的配置,我们还可以进一步定制Swagger2的功能,例如添加分组、过滤特定接口、自定义模型显示等。Springfox提供了丰富的插件和配置选项来满足不同需求。 通过以上步骤,我们可以将...

    springboot swagger2 demo

    - 编写`Swagger2Config`配置类,配置Swagger2的基本信息,例如API的版本、分组、描述等。 - 在Controller中使用Swagger2注解,如`@Api`标识控制器,`@ApiOperation`描述接口,`@ApiParam`描述参数。 - 启动项目,...

    springboot整合swagger2实例

    SpringBoot整合Swagger2实例详解 在现代Web开发中,API文档的重要性不言而喻,它为开发者提供了清晰...在实际项目中,开发者可以根据自身需求进一步定制Swagger2的配置,如添加分组、过滤接口等,以满足更复杂的需求。

    swagger2 整合springmvc

    首先,添加 Swagger2 的 Maven 或 Gradle 依赖,然后在 Spring Boot 或 Spring MVC 的配置文件中,创建 `Docket` 实例,定义 API 的基本信息,如版本、分组等。 3. **API 注解** - `@Api`: 用于标记一个控制器类,...

    Swagger3生成API文档配置(Demo)

    Swagger3 是一个强大的工具,用于构建 RESTful 风格的 API 文档。它通过注解的方式集成到Spring Boot应用中,使得开发者可以...在实际项目中,可以根据需求进一步定制Swagger3的配置,例如添加安全设置、分组接口等。

    springboot-swagger2实战

    2. 配置Swagger2:创建一个@Configuration注解的类,并在其中配置Swagger2的基本信息,如服务的基础路径、版本等。 3. 创建API文档:使用`@Api`、`@ApiOperation`、`@ApiParam`等注解,对Controller中的方法进行注释...

    SwaggerGroup.zip

    通过学习这个示例,开发者可以了解到如何在.NET Core中集成Swagger,如何定义和配置多个Swagger文档,以及如何使用特性来区分API接口的分组。这对于构建清晰、有序且易于使用的RESTful API文档至关重要。

    swagger2markup-demo.zip

    2. 配置Swagger:在Spring Boot的配置类中,我们需要创建一个`Docket`实例,定义API的基本信息,如版本、联系人信息、API的基础路径等,以及需要暴露的API接口。 3. 注解接口:在服务类或控制器类中,使用Swagger的...

    Springboot+swagger2整合

    然后创建一个配置Swagger2的类,通过`Docket` Bean来配置Swagger的基本信息,如API的版本、分组、描述等。 3. **注解API接口**:在实际的Controller层,使用Swagger2提供的注解(如`@Api`、`@ApiOperation`、`@...

    swagger_java_swagger_

    2. **配置Swagger**:在Spring Boot的配置类中,我们需要创建一个`@Configuration`注解的类,并在其中使用`@EnableSwagger2`注解来启用Swagger。接着,你可以定义一个`Docket`实例,用来配置Swagger的基本信息,如...

    swaggerUI静态资源包

    然后,通过`Docket`类配置Swagger,比如设置API的基本信息、版本、分组等。 3. 注解API:在Controller类和方法上使用Swagger的注解,如`@Api`、`@ApiOperation`、`@ApiParam`等,来描述API的细节。 4. 访问Swagger...

    Swagger3 API接口文档规范课程(教学视频+源代码)

    Swagger3 API接口文档规范课程 1.Swagger3 简介 2.Swagger3 HelloWorld实现 第一步:我们新建一个SpringBoot项目;...6 Swagger3 Docket 开关&过滤&分组 配置详解 6.1 开关设置enable 6.2 设置过滤 6.3 设置分组

    spring boot 整合 swagger2

    接下来,我们创建一个配置类来启用Swagger2。在`@Configuration`注解的类中,我们可以使用`@EnableSwagger2`注解来开启Swagger2的支持: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { } `...

    Spring Boot Swagger2 构建RESTful API

    3. 创建Docket对象:在配置类中,我们还需要创建一个Docket对象,用于定义Swagger的配置,比如API的版本、分组等。 ```java @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_...

    swagger3.0,带jwt的token以及前后端双端访问swagger的配置

    2. 定义 Security Scheme:在 Swagger 配置中,创建一个 Security Scheme 来表示 JWT 认证。这通常是一个 `apiKey` 类型的 Security Scheme,设置在请求头的 `Authorization` 字段。 3. 配置 JWT Filter:创建一个...

    Swagger(狂神说Java)(教学视频+源代码)

    3.4 配置Swagger==&gt;Config 3.5.测试运行,访问`http://localhost:8080/swagger-ui.html` 四、配置Swagger 五、Swagger配置扫描接口 问题:我只希望我的Swagger在生产环境中使用,在发布的时候不使用,应该怎么办? ...

    Swagger和knife4j_swagger_Swagger和knife4j_knife4jswagger_

    2. 多文档支持:除了默认的 Swagger 文档,还可以添加自定义文档,方便添加额外的说明和指引。 3. 高级搜索:提供快速的 API 搜索功能,帮助开发者快速定位所需接口。 4. 样例代码生成:自动生成不同语言的调用示例...

    springboot-swagger.zip

    然后,创建一个配置类,用于定义Swagger的基本信息和API的分组: ```java import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import ...

Global site tag (gtag.js) - Google Analytics