swagger添加接口分组

最新推荐文章于 2024-08-13 16:33:53 发布
最新推荐文章于 2024-08-13 16:33:53 发布
阅读量2.5k 收藏 1
点赞数
分类专栏： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/mlc19860417/article/details/102466097
版权 
package com.pcitc.aims.project.core.config;

import java.util.ArrayList;
import java.util.List;

import io.swagger.annotations.Contact;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.validation.MessageCodesResolver;
import org.springframework.validation.Validator;
import org.springframework.web.context.request.async.DeferredResult;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.config.annotation.*;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import io.swagger.annotations.ApiOperation;
import springfox.documentation.service.Parameter;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Author
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class Swagger2Config implements WebMvcConfigurer {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {

    }

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {

    }

    @Override
    public void configureAsyncSupport(AsyncSupportConfigurer configurer) {

    }

    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {

    }

    @Override
    public void addFormatters(FormatterRegistry registry) {

    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

    }

    /**
     * 显示swagger-ui.html文档展示页，还必须注入swagger资源：
     *
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    @Override
    public void addCorsMappings(CorsRegistry registry) {

    }

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {

    }

    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {

    }

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {

    }

    @Override
    public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) {

    }

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {

    }

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {

    }

    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) {

    }

    @Override
    public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) {

    }

    @Override
    public Validator getValidator() {
        return null;
    }

    @Override
    public MessageCodesResolver getMessageCodesResolver() {
        return null;
    }

    //------------------------------------所有--------------------

    /**
     * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     *
     * @return Docket
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //此包路径下的类，才生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project"))
                //加了ApiOperation注解的类，才生成接口文档
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
        //.globalOperationParameters();
    }

    //------------------------------------报表--------------------
    @Bean
    public Docket reportApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("reportApi")
                .genericModelSubstitutes(DeferredResult.class)
//                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project.report"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(reportApiInfo());
    }

    private ApiInfo reportApiInfo() {
        return new ApiInfoBuilder()
                .title("报表")//大标题
                .description("报表api")//详细描述
                .version("1.0")//版本
                .build();
    }
//------------------------------------办公--------------------

    @Bean
    public Docket officeApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("officeApi")
                .genericModelSubstitutes(DeferredResult.class)
//                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project.office"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(reportApiInfo());
    }

    private ApiInfo officeApiInfo() {
        return new ApiInfoBuilder()
                .title("办公")//大标题
                .description("办公api")//详细描述
                .version("1.0")//版本
                .build();
    }

    //------------------------------------系统配置--------------------
    @Bean
    public Docket sysApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("sysApi")
                .genericModelSubstitutes(DeferredResult.class)
//                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project.sys"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(reportApiInfo());
    }

    private ApiInfo syspiInfo() {
        return new ApiInfoBuilder()
                .title("系统配置")//大标题
                .description("系统配置api")//详细描述
                .version("1.0")//版本
                .build();
    }

    //----------------------------计划--------------------------
    @Bean
    public Docket planApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("planApi")
                .genericModelSubstitutes(DeferredResult.class)
//                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project.plan"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(reportApiInfo());
    }

    private ApiInfo planApiInfo() {
        return new ApiInfoBuilder()
                .title("计划")//大标题
                .description("计划api")//详细描述
                .version("1.0")//版本
                .build();
    }

    //----------------------------字典--------------------------
    @Bean
    public Docket dicApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("dicApi")
                .genericModelSubstitutes(DeferredResult.class)
//                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project.dic"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(reportApiInfo());
    }

    private ApiInfo dicApiInfo() {
        return new ApiInfoBuilder()
                .title("字典")//大标题
                .description("字典api")//详细描述
                .version("1.0")//版本
                .build();
    }

    //----------------------------公共--------------------------
    @Bean
    public Docket commonApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("commonApi")
                .genericModelSubstitutes(DeferredResult.class)
//                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.pcitc.aims.project.common"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(reportApiInfo());
    }

    private ApiInfo commonApiInfo() {
        return new ApiInfoBuilder()
                .title("公共")//大标题
                .description("公共api")//详细描述
                .version("1.0")//版本
                .build();
    }

    /**
     * api文档的详细信息函数,注意这里的注解引用的是哪个
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // //大标题
                .title("项目 后台服务API接口文档")
                // 版本号
                .version("1.0")
//          .termsOfServiceUrl("NO terms of service")
                // 描述
                .description("restful 风格接口")
                // 作者
//          .contact(new Contact("scott", "http://jeecg.org", "jeecgos@163.com"))
//                .license("The Apache License, Version 2.0")
//                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                .build();
    }

}
mlc19860417
关注
专栏目录
swagger配置分组
yks的博客
04-12 1722
在实际生产环境中，为了方便接口对应各自的开发人员，可以分组也即定义多个Docket对象 package com.yk.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.RequestHandlerSelectors; import s
swaggerAPI接口文档分组
gfdgdshhg的博客
02-17 3984
swagger是一个深度集成的后台API文档工具,极大的方便了后端的开发测试以及和前端的对接工作。但是当项目中的接口越来越多时，会导致页面上的接口过多，查看起来不是很方便，这时可以使用swagger的分组功能将接口进行分组分页展示。分组的规则可以基于路径和注解等，下面主要介绍下基于注解的分类，这种方法比较灵活。 先上结果 分组一 分组二 首先定义用于标志分组的注解 然后在swagger配置类...
spring-boot-starter-swagger 1.2.0.RELEASE：新增分组配置功能
weixin_33824363的博客
08-20 190
2019独角兽企业重金招聘Python工程师标准>>> ...
在 C#/.NET Core 的 Web API 中使用 Swagger 按模块和版本分组并实现排序
最新发布
吾家有猫名探花的博客
08-13 991
在开发 RESTful API 时，良好的文档是必不可少的。Swagger 是一种广泛使用的 API 文档工具，可以帮助我们生成交互式的 API 文档。然而，当项目规模增大，API 数量众多时，我们需要将 API 按照模块和版本进行分组，以便更好地管理和查找。本文将介绍如何在 .NET Core Web API 中使用 Swagger 按模块和版本分组，并使用自定义特性实现这一目标。为了实现按模块和版本分组，我们需要创建一个自定义特性。这个特性将用于标记我们的控制器，并包含模块名称、版本号和描述信息。
Swagger 接口分组
一路向前
07-25 474
swagger分组处理
swagger2 分组
weixin_39522272的博客
08-12 7463
自定义注解 package com.awj.mall.restfulapi.common.swagger.annotion; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import jav...
Swagger2 进行分组
热门推荐
qq_41973154的博客
04-23 1万+
Swagger是一个很好的api文档，如果我们的接口过于多，那么一个页面很难展示，查找不方便，那么我们就对swagger进行分组。 分组策略为按包名称分组，另一个是按请求路径进行分类。 @Configuration @EnableSwagger2 public class SwaggerConfiguration { //设置显示状态，value是在pom中配置的 @Value("${mein...
swagger接口文档改良添加左侧菜单.rar
07-28
Swagger接口文档改良添加左侧菜单是针对API开发过程中的一个重要优化，旨在提高开发人员对API文档的使用效率。Swagger是一款流行的RESTful API文档工具，它能够自动生成、描述、测试和发现Web服务接口。通过在...
Swagger:swagger分组配置和文档介绍
qq_45302623的博客
01-21 2730
Swagger:swagger分组配置和文档介绍 花开堪折直需折，莫待无花空折枝 分组配置： 没有使用分组配置时，所用的api都在默认的分组下，如果api接口过多，显然是不利于管理的： 配置api文档分组：创建swagger2配置文件：Swagger2Config @Configuration @EnableSwagger2 public class Swagger2Config { //前台文档分组 @Bean public Docket webApiConfig(){
swagger 动态设置版本号_Swagger实现接口版本号管理
weixin_35719402的博客
02-11 1773
前言：使用swagger暴露对外接口时原则是每个系统在不同的迭代版本仅仅需要暴露该迭代版本的接口给外部使用，客户端不需要关心不相关的接口先来看张效果图 下面是实现代码：定义注解ApiVersion：/*** 接口版本管理注解* @author 周宁* @Date 2018-08-30 11:48*/@Retention(RetentionPolicy.RUNTIME)@Target(Element...
swagger2使用(4):分组
不积跬步，无以至千里
02-27 1552
Swagger分组 默认没配置分组，swagger是default分组 如图将人作为分组,选择分组，表示各自下面所属的接口 代码实现 package com.it2.swagger.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.env.Enviro
Swagger API接口创建
11-27
前言 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码，了解更多内容，见参考资料。 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。 一、使用介绍 什么是 Swagger? Swagger™的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。 浏览 Swagger-Spec 去了解更多关于Swagger 项目的信息，包括附加的支持其他语言的库。
用swagger2创建项目的接口
aalililii的博客
02-12 469
项目结构图： 创建接口步骤： 1、创建一个package，命名为config 创建SwaggerConfig类和WebMvcConfig类 代码如下： SwaggerConfig.class @Configuration //必须存在 @EnableSwagger2 //必须存在 @EnableWebMvc //必须存在 //必须存在 扫描的API Controller包 @ComponentScan(basePackages = {"com.example.newdemo.controller"}) p
swagger接口文档【动态接口分组】
旅途
01-29 3140
一、期望效果图示 二、代码实现 1、自定义注解：@ApiVersion 支持方法级别、类级别，优先级：方法级别 优于 类级别 @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD, ElementType.TYPE}) public @interface ApiVersion { /** * 接口版本号(对应swagger中的group) */ String[] group() de
【Swagger2源码级教学】05设置分组
m0_55659498的博客
09-17 787
​ 设置多个分组，意味着，需要多种配置方案，而一个Docket，对应一种配置方案，这个时候就需要多个Docket实例去实现分组。​ 可以通过设置分组，将api按。分开，给不同的前端开发人员使用。
如何在 swgger 中设置连接前后端的 API 接口
m0_72134256的博客
08-26 1478
swagger 可以根据后台接口自动生成可视化的 restful 风格的 API 文档，并可以进行 API 测试（发送各种请求，测试接口）1、前端人员不用再去理解后端代码，后端人员也不用专门编写接口文档。2、swagger 直接自动生成可供测试、可视化的 API 文档，前端人员在不知道后端代码的情况下，也能根据 swagger 提供的 API 文档理解每个接口的作用，并可以测试接口是否能够正常使用。......
swagger groupName分组配置(根据路径或正则表达式过滤分组)
leomoon
02-14 2184
SwaggerConfig.java package com.lmp.config; import com.lmp.common.config.Global; import io.swagger.annotations.ApiOperation; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springf
swagger2的使用
weixin_42364816的博客
01-11 245
前后端分离项目中，对于API的管理一直很头疼，swagger2即可以解决这个问题！ 1）引入依赖： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2...
Swagger--分组 & 接口注释
天行健 君子以自强不息，地势坤 君子以厚德载物。
06-06 5175
1. Swagger--分组和接口注释及小结 1.1 配置分组 如果没有配置分组，默认是default。通过groupName()方法即可配置分组： groupName("group01") // 配置分组 SwaggerConfig.java /** * 配置docket以配置Swagger具体参数 */ @Bean public Docket docket(Environment environment) { return new Dock
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值