首页 > 其他分享 >Swagger 分组配置

Swagger 分组配置

时间:2023-06-01 19:03:43浏览次数:38  
标签:Swagger 配置 version 分组 import springfox apiInfo 商城


 

pom文件依赖

<properties>
        <springfox-swagger2.version>2.9.2</springfox-swagger2.version>
        <springfox-swagger-ui.version>2.9.2</springfox-swagger-ui.version>
        <knife4j-spring-boot-starter.version>2.0.2</knife4j-spring-boot-starter.version>
        <springfox-bean-validators.version>2.9.2</springfox-bean-validators.version>
        <shiro-redis.version>3.2.3</shiro-redis.version>
        <shiro-spring.version>1.4.1</shiro-spring.version>
    </properties> 
       
    <dependencies>
        <!--swagger2 依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox-swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox-swagger-ui.version}</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>${knife4j-spring-boot-starter.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-bean-validators</artifactId>
            <version>${springfox-bean-validators.version}</version>
        </dependency>
    </dependencies>    <properties>
        <springfox-swagger2.version>2.9.2</springfox-swagger2.version>
        <springfox-swagger-ui.version>2.9.2</springfox-swagger-ui.version>
        <knife4j-spring-boot-starter.version>2.0.2</knife4j-spring-boot-starter.version>
        <springfox-bean-validators.version>2.9.2</springfox-bean-validators.version>
        <shiro-redis.version>3.2.3</shiro-redis.version>
        <shiro-spring.version>1.4.1</shiro-spring.version>
    </properties> 
       
    <dependencies>
        <!--swagger2 依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox-swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox-swagger-ui.version}</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>${knife4j-spring-boot-starter.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-bean-validators</artifactId>
            <version>${springfox-bean-validators.version}</version>
        </dependency>
    </dependencies>

 

配置文件 进行分组配置

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {
    /**
     * 设置基础分组(包含所有注解标注过的接口)
     * @return
     */
    @Bean
    public Docket docketBase_seller() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo_seller())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xinfeng.controller.seller"))
                .paths(PathSelectors.any())     //正则匹配请求路径,并分配至当前分组,当前所有接口
                .build()
                .groupName("卖家管理系统")      //分组名称
                .globalOperationParameters(null);
    }

    private ApiInfo apiInfo_seller() {
        return new ApiInfoBuilder()
                .title("新丰商城-卖家接口模块")
                .description("新丰商城-193中级项目")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }

    @Bean
    public Docket docketBase_setting() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo_setting())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xinfeng.controller.setting"))
                .paths(PathSelectors.any())     //正则匹配请求路径,并分配至当前分组,当前所有接口
                .build()
                .groupName("商城管理系统")      //分组名称
                .globalOperationParameters(null);
    }

    private ApiInfo apiInfo_setting() {
        return new ApiInfoBuilder()
                .title("新丰商城-商城管理系统")
                .description("新丰商城-193中级项目")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }

    @Bean
    public Docket docketBase_home() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo_home())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xinfeng.controller.home"))
                .paths(PathSelectors.any())     //正则匹配请求路径,并分配至当前分组,当前所有接口
                .build()
                .groupName("商城系统")      //分组名称
                .globalOperationParameters(null);
    }

    private ApiInfo apiInfo_home() {
        return new ApiInfoBuilder()
                .title("新丰商城-商城系统")
                .description("新丰商城-193中级项目")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

 

 

 

 

 

标签:Swagger,配置,version,分组,import,springfox,apiInfo,商城
From: https://blog.51cto.com/u_14671216/6397692

相关文章

  • IDEA 中 .gitignore 文件中 配置 忽略上传的文件
    target/pom.xml.tagpom.xml.releaseBackuppom.xml.versionsBackuppom.xml.nextrelease.propertiesdependency-reduced-pom.xmlbuildNumber.properties.mvn/timing.properties.mvn/wrapper/maven-wrapper.jar//下面的需要手动添加**/mvnw**/mvnw.cmd**/.mvn.idea**......
  • mysql5.7配置文件详解
    8核心32G独立mysql服务器的配置文件如下:[client]port=3306socket=/data/mysql/mysql.sock[mysql]prompt="mysql[\d]>"no-auto-rehash[mysqldump]quick[mysqld]user=mysqlport=3306basedir=/usr/local/mysqldatadir=/data/mysqlsocket=/......
  • Spring Cloud开发实践(七): 集成Consul配置中心
    目录SpringCloud开发实践(一):简介和根模块SpringCloud开发实践(二):Eureka服务和接口定义SpringCloud开发实践(三):接口实现和下游调用SpringCloud开发实践(四):Docker部署SpringCloud开发实践(五):Consul-服务注册的另一个选择SpringCloud开发实践(六):基......
  • 手把手教你Spring Cloud Alibaba教程:使用Nacos作为配置中心
    我们在上面:手把手教你SpringCloudAlibaba教程:nacos安装手把手教你SpringCloudAlibaba教程:使用nacos实现服务注册与发现了解了nacos和springCloudAlibaba的部署和使用,现在我们来了解下nacos作为配置中心应该如何使用。Nacos除了实现了服务的注册发现之外,还将配置中心功能整合......
  • Spring Boot架构中添加Swagger
    基于SpringBoot+Springmvc+mybatis+mybatis-generator代码自动生成架。在上面的文章中我们实行了基本springBoot架构,接下来我们给这个架构添加swagger接口调试:一:添加相应jar包,在pom.xml中添加如下代码:<!--swagger2配置pom开始--><dependency><groupId>io.springfox</groupId>......
  • Kafka环境的配置
    大家对于消息队列,想必不会很陌生,特别是ActiveMQ和RabbitMQ,今天我将会为大家介绍下Kafka在centOs系统中的安装。第一步:准备好包。对于kafka,你需要zookeeper,所以你需要下载zookeeper。点击zookeeper下载下载zookeeper后放入到centos中.放入文件夹software中。接着准备kafka.点击下......
  • nginx 配置 https
    nginx配置https按照如下格式修改配置文件,80端口会自动转给443端口,这样就强制使用SSL证书加密了。访问http的时候会自动跳转到https上面。server{listen80;server_namewww.域名.com;rewrite^(.*)https://$server_name$1permanent;}server{listen443;se......
  • 浏览器配置微信模拟器
     1.打开浏览器控制台,选择移动端,选择Responsive->Edit 2.添加自定义设备①点击Addcustondevice,②输入设备名称如weChat,③输入配置内容:mozilla/5.0 (linux; u; android 4.1.2; zh-cn; mi-one plus build/jzo54k) applewebkit/534.30 (khtml, like gecko......
  • 如何将自己习惯的配置带进新的 workspace
    workspace1\.metadata\.plugins\org.eclipse.core.runtime\.settings\org.eclipse.ui.workbench.prefs workspace2\.metadata\.plugins\org.eclipse.core.runtime\.settings\org.eclipse.ui.workbench.prefs 将1替换掉2即可    就找到你改的快捷键记录在哪里了......
  • 数据库配置
    数据库登录名配置1.在sa权限下新增数据库2.数据库-安全性-登录名-用户-用户映射-新数据库-勾选db_owner 预发布环境新建正式站数据库备份数据库1.正式站备份最新bak文件2.放正式站域名下载bak文件zip文件3.预发布环境数据库新增新的数据库4.还原数据库5.更新config文......