【springboot】简易模块化开发项目整合Swagger2

已于 2024-10-05 18:13:38 修改
阅读量1.3k 收藏 29
点赞数 41
分类专栏： # 快速开发Demo 文章标签： spring boot java 后端
于 2024-10-05 18:10:34 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40878316/article/details/142717108
版权

接上一项目【springboot】简易模块化开发项目整合MyBatis-plus，进行拓展项目

1.新建模块

右键项目→New→Module，新建一个模块

在这里插入图片描述

父项目选择fast-demo，命名为fast-demo-config，用于存放所有配置项

在这里插入图片描述

添加后，项目结构如图

在这里插入图片描述

2.添加swagger依赖

fast-demo-config模块的pom.xml中添加swagger依赖

    <dependencies>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
            <version>2.3.0</version>
		</dependency>
    </dependencies>

在fast-demo-config模块新建SwaggerConfig类，用于配置swagger相关设置，配置内容如下

@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class SwaggerConfig {
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
            	// 这里填写的是controller层的路径，填写自己的
                .apis(RequestHandlerSelectors.basePackage("com.cyfy.fastdemo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("页面标题")
                .contact(new Contact("创建人名称","项目路径","邮箱"))
                .version("版本号")
                .description("描述")
                .build();
    }
}

项目结构如图

在这里插入图片描述

3.swagger测试

fast-demo-web模块中导入fast-demo-config模块

		<dependency>
            <groupId>com.cyfy</groupId>
            <artifactId>fast-demo-config</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

进入application.yml配置文件中，增加如下字段

swagger:
  enable: true

进入fast-demo-web模块中d UserController类中，增加swagger注解内容

@RestController
@Api("用户信息接口")
public class UserController {
    @Autowired
    private UserService userService;


    @RequestMapping("/user")
    @ApiOperation(value = "获取所有用户信息", notes = "返回用户信息")
    public List<User> getUserList(){
        return userService.getUserList();
    }
}

运行项目后，浏览器输入http://localhost:8080/swagger-ui.html，便可查看到相关接口文档

在这里插入图片描述

项目结构

在这里插入图片描述

fast-demo-config模块

pom.xml

<?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>
        <artifactId>fast-demo</artifactId>
        <groupId>com.cyfy</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>fast-demo-config</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

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

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
        </dependency>
    </dependencies>
</project>

SwaggerConfig

package com.cyfy.fastdemo.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class SwaggerConfig {
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cyfy.fastdemo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("页面标题")
                .contact(new Contact("创建人名称","项目路径","邮箱"))
                .version("版本号")
                .description("描述")
                .build();
    }
}
fast-demo-web模块

pom.xml

<?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>
        <artifactId>fast-demo</artifactId>
        <groupId>com.cyfy</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>fast-demo-web</artifactId>
    <packaging>pom</packaging>
    <modules>
        <module>fast-demo-controller</module>
        <module>fast-demo-service</module>
        <module>fast-demo-dao</module>
    </modules>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--引入mybatisPlus 包含了 jdbc-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>

        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
		<!-- 导入工具配置模块 -->
        <dependency>
            <groupId>com.cyfy</groupId>
            <artifactId>fast-demo-config</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>
fast-demo-controller模块

application.yml

# 数据库连接配置,记得新建一个数据库
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/my_demo?useUnicode=true&characterEncoding=UTF-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 123456
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

mybatis-plus:
  # 指定 Mapper XML 文件的位置，使用 classpath 通配符指定路径
  mapper-locations: classpath:/mapper/**/*.xml
  # 指定实体类的包路径，用于自动扫描并注册类型别名
  type-aliases-package: com.cyfy.springboot_one.pojo
  global-config:
    db-config:
      id-type: input
      # 驼峰下划线转换（将数据库字段的下划线命名规则转换为 Java 实体类属性的驼峰命名规则）
      db-column-underline: true
      # 刷新 mapper
      refresh-mapper: true
  configuration:
    # 将 Java 实体类属性的驼峰命名规则转换为数据库字段的下划线命名规则
    map-underscore-to-camel-case: true
    # 查询结果中包含空值的列，在映射的时候，不会映射这个字段
    call-setters-on-nulls: true
    # 开启 sql 日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    # 关闭 sql 日志
    # log-impl: org.apache.ibatis.logging.nologging.NoLoggingImpl

swagger:
  enable: true

UserController

package com.cyfy.fastdemo.controller;

import com.cyfy.fastdemo.entity.User;
import com.cyfy.fastdemo.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
@Api("用户信息接口")
public class UserController {
    @Autowired
    private UserService userService;


    @RequestMapping(value = "/user",method = RequestMethod.GET)
    @ApiOperation(value = "获取所有用户信息", notes = "返回用户信息")
    public List<User> getUserList(){
        return userService.getUserList();
    }
}
fast-demo模块

pom.xml

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.cyfy</groupId>
    <artifactId>fast-demo</artifactId>
    <packaging>pom</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <modules>
        <module>fast-demo-web</module>
        <module>fast-demo-config</module>
    </modules>
    <name>fast-demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.6.13</spring-boot.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.8.0</version>
            </dependency>

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

            <dependency>
                <groupId>javax.xml.bind</groupId>
                <artifactId>jaxb-api</artifactId>
                <version>2.3.0</version>
            </dependency>

            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.5.2</version>
            </dependency>

            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
                <configuration>
                    <mainClass>com.cyfy.fastdemo.FastDemoApplication</mainClass>
                    <skip>true</skip>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>
SpringBoot集成swagger2
m0_37730948的博客
04-20 606
​ 在当今前后端框架流行的时代，一个完整并且规范的接口文档是必不可少的。Swagger是一款Restful接口风格文档在线自动生成、接口功能测试的集成插件，用于生成、描述和可视化Restful风格的Web服务。软件可以实现接口文档同API始终保持同步。同过去的离线接口文档相比起来，整体提高了项目的开发效率，减少了前后端成员之间的非必要沟通。​ 官网地址：https://swagger.io/
Gateway+Swagger2配置聚合文档
我的博客
04-25 1853
Spring Cloud Gateway网关模块聚合各微服务的Swagger接口文档 效果如下图： 相关pom依赖 <!-- 网关路由代理 (仅网关)--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</arti
Spring boot 整合 Swagger2 （生成接口文档的方式）
qq_38795959的博客
04-23 379
Swagger2是一个方便后端编写接口文档的开源项目，并提供界面化测试。 依赖： <!--Swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version...
Spring Boot（十四）：集成Swagger2
最新发布
tunan666的博客
09-13 1298
Spring Boot中集成Swagger2
SpringBoot（七）：SpringBoot整合Swagger2
热门推荐
Saytime
07-10 7万+
相信各位在公司写API文档数量应该不少，当然如果你还处在自己一个人开发前后台的年代，当我没说，如今为了前后台更好的对接，还是为了以后交接方便，都有要求写API文档。 手写Api文档的几个痛点： 文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。接口返回结果不明确不能直接在线测试接口，通常需要使用工具，比如postman接口文档太多，不好管理 Swagg
SpringBoot集成Swagger2
SmallCat0912的博客
12-21 665
SpringBoot中集成Swagger2
SpringBoot 集成 Swagger2
asksl的博客
11-29 827
SpringBoot 集成 Swagger2
前后端分离的简易点餐系统：SpringBoot+Vue实现
2. **SpringBoot**：作为后端服务框架，SpringBoot集成了大量常用的功能模块，如安全性、事务处理等，并提供自动配置功能，能够快速搭建和运行应用程序。SpringBoot通常与Spring MVC配合使用，通过RESTful API与前端...
springboot+jwt+shiro+vue+elementUI+axios+redis+mysql完成一个前后端分离的博客项目（笔记,帮填坑）
web18224617243的博客
08-02 1065
后端的一个骨架基本完成然后开始我们的前端开发接下来，我们来完成vueblog前端的部分功能。可能会使用的到技术如下vueelement-uiaxios。
Java实战项目源码分享与成长进步指南
项目内容涉及多个实践领域，包括但不限于RESTful API文档生成工具Swagger、SpringBoot与Shiro的整合、秒杀业务处理、电信数据采集系统、Web服务器开发、Servlet与JavaScript的搜索框智能提示实现、基于JSP的在线聊天...
springboot整合swagger2
m0_74295724的博客
04-17 1527
springboot整合swagger2
SpringBoot 整合Swagger2
小钟不想敲代码
08-11 7713
SpringBoot 整合Swagger2
SpringBoot整合Swagger2
m0_62019369的博客
01-06 1733
随着需求的变更和项目的优化、推进，接口的细节在不断地演变，接口描述文档也需要同步修订，可是文档和代码处于两个不同的媒介，除非有严格的管理机制，否则很容易出现文档、接口不一致的情况；注解描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用 @ApiImplicitParam注解进行描述的时候；1）API 接口众多，细节复杂，需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等，想要高质量的完成这份文档需要耗费大量的精力；
Spring Boot集成Swagger2
文帝的博客
05-18 771
SpringBoot集成Swagger2
SpringBoot中集成Swagger2
这是我的笔记本，记录学习历程，分享学习经验，菜鸡一枚，感谢支持！
06-09 1215
Swagger是非常流行的API框架，能够自动生成RESTFul 风格的API文档，还可以在线测试后台接口。使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等。前后端分离的开发模式下，前端通过后端的API文档来进行开发和联调，效率更高。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值