common包：SpringBoot整合Swagger3

最新推荐文章于 2024-05-01 08:48:56 发布

【绪森】

最新推荐文章于 2024-05-01 08:48:56 发布

阅读量744

点赞数

分类专栏： SpringBoot Common 文章标签： spring boot java

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接：https://blog.csdn.net/weixin_44231769/article/details/124672642

版权

SpringBoot Common 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

目录

1.父工程Pom文件

2.common-swagger模块

2.2 SwaggerProperties文件

2.3 SwaggerConfig文件

2.4 spring.factories文件

3.csdn-test项目测试swagger

3.2 application.yml文件

3.3 CsdnTestApplication文件

3.4 TestController文件

4.启动项目，看效果

项目结构

1.父工程Pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.mcs</groupId>
    <artifactId>CSDN</artifactId>
    <packaging>pom</packaging>
    <version>1.0</version>
    
    <modules>
        <module>csdn-common</module>
        <module>csdn-test</module>
    </modules>

    <properties>
        <csdn.version>1.0</csdn.version>
        <java.version>1.8</java.version>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
        <swagger.fox.version>3.0.0</swagger.fox.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <!-- SpringBoot 依赖配置 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <!-- Swagger3 依赖 -->
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-boot-starter</artifactId>
                <version>${swagger.fox.version}</version>
            </dependency>

            <!-- Swagger3 common包 -->
            <dependency>
                <groupId>com.mcs</groupId>
                <artifactId>common-swagger</artifactId>
                <version>${csdn.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

2.common-swagger模块

2.1 Pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>com.mcs</groupId>
        <artifactId>csdn-common</artifactId>
        <version>1.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>common-swagger</artifactId>

    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
    </dependencies>

</project>

2.2 SwaggerProperties文件

package com.mcs.common.swagger.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

/**
 * swagger属性配置类
 */
@Configuration
@ConfigurationProperties(prefix = "springfox.documentation.swagger")
public class SwaggerProperties {

    /** 扫描包路径 */
    private String basePackage;

    /** 标题 */
    private String title;

    /** 描述 */
    private String description;

    /** 版本 */
    private String version;

    /** 联系人名字 */
    private String contactName;

    /** 联系人url */
    private String contactUrl;

    /** 联系人email */
    private String contactEmail;

    public String getBasePackage() {
        return basePackage;
    }

    public void setBasePackage(String basePackage) {
        this.basePackage = basePackage;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getContactName() {
        return contactName;
    }

    public void setContactName(String contactName) {
        this.contactName = contactName;
    }

    public String getContactUrl() {
        return contactUrl;
    }

    public void setContactUrl(String contactUrl) {
        this.contactUrl = contactUrl;
    }

    public String getContactEmail() {
        return contactEmail;
    }

    public void setContactEmail(String contactEmail) {
        this.contactEmail = contactEmail;
    }
}

2.3 SwaggerConfig文件

package com.mcs.common.swagger.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.*;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * swagger配置类
 */
@Configuration
@EnableConfigurationProperties(SwaggerProperties.class)
public class SwaggerConfig { 
    
    private SwaggerProperties properties;

    @Autowired
    public void setProperties(SwaggerProperties properties) {
        this.properties = properties;
    }

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo(properties))
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(SwaggerProperties properties) {
        return new ApiInfoBuilder()
                .title(properties.getTitle())
                .description(properties.getDescription())
                .contact(new Contact(properties.getContactName(), properties.getContactUrl(), properties.getContactEmail()))
                .version(properties.getVersion())
                .build();
    }
}

swagger3与swagger2不同，开启swagger3的注解是@EnableOpenApi。swagger3默认是开启的，所以@EnableOpenApi注解可不写。

2.4 spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.mcs.common.swagger.config.SwaggerConfig

3.csdn-test项目测试swagger

3.1 pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>com.mcs</groupId>
        <artifactId>CSDN</artifactId>
        <version>1.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>csdn-test</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.mcs</groupId>
            <artifactId>common-swagger</artifactId>
        </dependency>
    </dependencies>

</project>

3.2 application.yml文件

server:
  port: 8080

spring:
  application:
    name: csdn-test

springfox:
  documentation:
    # swagger3开关位置，默认是开启的
    enabled: true
    swagger:
      title: test-swagger
      description: "测试swagger"
      version: 1.0.0
      contactName: mcs
      contactEmail: xxx@qq.com
      contactUrl: http://xxx.com

swagger3通过springfox.documentation.enabled控制开关；swagger2可以通过@ConditionalOnProperty注解控制。

3.3 CsdnTestApplication文件

package com.mcs.test;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class CsdnTestApplication {
    public static void main(String[] args) {
        SpringApplication.run(CsdnTestApplication.class, args);
    }

}

3.4 TestController文件

package com.mcs.test.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(tags = "测试Swagger")
public class TestController {

    @ApiOperation(value = "测试Swagger")
    @PostMapping("/test")
    public String test() {
        return "test";
    }
}

4.启动项目，看效果

访问路径http://localhost:8080/swagger-ui/index.html

注意，swagger3的访问路径与swagger2是不同的。

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
common包：SpringBoot整合Swagger3

Swagger3 Common包
复制链接

扫一扫

专栏目录

评论

被折叠的条评论为什么被折叠?

到【灌水乐园】发言

查看更多评论

添加红包

成就一亿技术人!

hope_wisdom

发出的红包

实付元

使用余额支付

点击重新获取

扫码支付

钱包余额 0

抵扣说明：

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