springboot整合swagger

news2024/11/17 17:54:26

特别说明：本次项目整合基于idea进行的，如果使用Eclipse可能操作会略有不同，不过总的来说不影响。

springboot整合之如何选择版本及项目搭建

springboot整合之版本号统一管理 

springboot整合mybatis-plus+durid数据库连接池

springboot整合swagger

springboot整合mybatis代码快速生成

springboot整合之统一结果返回

springboot整合之统一异常处理

springboot整合之logback日志配置

springboot整合pagehelper分页

springboot整合本地缓存

springboot整合redis + redisson

springboot整合elasticsearch

springboot整合rabbitMq

springboot整合canal实现缓存一致性

springboot整合springSecurity(前后端不分离版本)

在开始之前先说一下自己的理解。我觉得既然要使用，首先就要知道为什么要用？该不该用？如果说我们的项目就俩人开发的一个小项目，又没有前后端分离，而且有比较急着上线，那我觉得这种真是没有必要用swagger。这里只是举个例子，就是告诉大家没有必要为了swagger而swagger。

我认为swagger更适合前后端分离情况，或者需要协同开发给别人提供接口测试的时候使用。在这种情况下能够提高协同的效率。如果一项技术的引进不能提高开发效率，或者对项目本身没有什么提升，我觉得引入的意义就不大。而且引入很多没用的文件对内存也是影响，有时候甚至会影响我们程序的性能。

如果确定适合，那就整合进来。但是千万注意一点。这个只能是测试环境使用，千万不要放到正式环境。这个一定要注意！！！关于怎么设置正式环境不可用会在本次整合中给出示范。

我在项目开发中用过两种不同风格的swagger UI，这里会都展示一下，具体用那种大家可以根据需要来选择就好了。

一、pom文件引入

因为跟之前的几次的整合相比这次对版本进行了统一的依赖管理，所以直接贴上了所有的整合pom,如果有小伙伴是按照之前一步一步来的，这里直接替换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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--spring-boot 依赖版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
    </parent>

    <!--当前项目坐标-->
    <groupId>com.example</groupId>
    <artifactId>springboot-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-demo</name>
    <description>springboot-demo</description>

    <!--版本依赖管理-->
    <properties>
        <java.version>8</java.version>
        <druid.version>1.2.15</druid.version>
        <mybatis-plus.version>3.4.2</mybatis-plus.version>
        <swagger.version>2.9.2</swagger.version>
    </properties>


    
    <dependencies>
        <!--spring-boot-starter 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <!--spring-boot-starter-web 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--热启动依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <!--lombok 依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!--spring-boot-starter-test 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--mysql 链接驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--druid数据库连接池-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>${druid.version}</version>
        </dependency>

        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>

        <!--swagger.ui-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

二、创建swagger配置类

首先把位置说明一下

package com.example.springbootdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
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
@Profile("dev")
public class SwaggerConfig {
	/**
	 * 创建API应用 apiInfo() 增加API相关信息
	 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
	 * 本例采用指定扫描的包路径来定义指定要建立API的目录。
	 */
	@Bean
	public Docket createRestApi() {

		return new Docket(DocumentationType.SWAGGER_2)
				//接口说明信息
				.apiInfo(apiInfo())
				// 选择那些路径和api会生成document
				.pathMapping("/").select()
				// 对所有api进行监控
				.apis(RequestHandlerSelectors.any())
				.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build();
	}


	/**
	 * 创建该API的基本信息（这些基本信息会展现在文档页面中）
	 *
	 * @return
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("测试接口文档")
				.contact(new Contact("William","https://www.baidu.com","William940115@163.com"))
				.termsOfServiceUrl("https://www.baidu.com")
				.description("测试接口文档")
				.version("1.0")
				.build();
	}

}

说明：

@Configuration   将当前配置类交给spring管理
@EnableSwagger2  开启swagger注解，此注解也可以添加到spring boot启动类
@Profile("dev")  开启只有dev环境生效，此外swagger也提供了基于环境的可见性设置，这里就不作详细介绍了，如果感兴趣的可以自己研究一下，也很简单。

三、创建测试类

 因为测试，我们先临时写一个测试类，主要就是测试我们的swagger是否整合成功。

package com.example.springbootdemo.controller;

import com.example.springbootdemo.entity.User;
import com.example.springbootdemo.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.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @description: TestController <br>
 * @date: 2022/12/17 0017 上午 10:06 <br>
 * @author: William <br>
 * @version: 1.0 <br>
 */
@Api(tags = "测试接口")
@RestController
@RequestMapping("test")
public class TestController {

    @Autowired
    private UserService userService;


    @ApiOperation("根据用户ID获取用户信息接口")
    @GetMapping("user/{id}")
    public String getUserById(@PathVariable("id") Integer id){
        //参数校验
        if(id == null || id<=0){
            return "参数非法";
        }
        User user = userService.getById(id);
        return user.toString();
    }

}

四、启动测试

首先给大家看一下我比较喜欢的一种，输入http://localhost:8080/doc.html进行访问

 各人觉得很不错的一个UI页面，看起来很舒服。而且支持离线导出，相当给力。个人觉得比swagger自带的UI要好用一点。

然后就是另一种：输入http://localhost:8080/swagger-ui.html

 这种是我们比较常见的。我以前也经常用，后来发现了第一种这种就没用了。

 OK，到这里整合就完成了。下面就是常用的一些注解了。

五、swagger常用注解 

从官方给的解释，各位学习使用的时候建议直接从这里看，而且都给了例子，很简单。

NameDescription
@ApiMarks a class as a Swagger resource.
@ApiImplicitParamRepresents a single parameter in an API Operation.
@ApiImplicitParamsA wrapper to allow a list of multiple ApiImplicitParam objects.
@ApiModelProvides additional information about Swagger models.
@ApiModelPropertyAdds and manipulates data of a model property.
@ApiOperationDescribes an operation or typically a HTTP method against a specific path.
@ApiParamAdds additional meta-data for operation parameters.
@ApiResponseDescribes a possible response of an operation.
@ApiResponsesA wrapper to allow a list of multiple ApiResponse objects.
@AuthorizationDeclares an authorization scheme to be used on a resource or an operation.
@AuthorizationScopeDescribes an OAuth2 authorization scope.


好了，到这里我们swagger就整合好了。另外说一下，为了展示两种效果所以我在pom中引入了两个swagger-ui的jar包，后面我会删掉一个，只保留一个。大家可以根据自己需要来。我觉得最好只保留一个就好了。

六、最终pom

我保留的是我比较喜欢的一个，修改以后的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--spring-boot 依赖版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
    </parent>

    <!--当前项目坐标-->
    <groupId>com.example</groupId>
    <artifactId>springboot-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-demo</name>
    <description>springboot-demo</description>

    <!--版本依赖管理-->
    <properties>
        <java.version>8</java.version>
        <druid.version>1.2.15</druid.version>
        <mybatis-plus.version>3.4.2</mybatis-plus.version>
        <swagger.version>2.9.2</swagger.version>
        <swagger-ui.version>1.9.6</swagger-ui.version>
    </properties>



    <dependencies>
        <!--spring-boot-starter 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <!--spring-boot-starter-web 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--热启动依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <!--lombok 依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!--spring-boot-starter-test 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!--mysql 链接驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--druid数据库连接池-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>${druid.version}</version>
        </dependency>

        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>

        <!--swagger.ui-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>${swagger-ui.version}</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/113317.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

node.js+uni计算机毕设项目儿童健康成长档案小程序（程序+小程序+LW）

node.js+uni计算机毕设项目儿童健康成长档案小程序（程序+小程序+LW）

该项目含有源码、文档、程序、数据库、配套开发软件、软件安装教程。欢迎交流 项目运行 环境配置&#xff1a; Node.js Vscode Mysql5.7 HBuilderXNavicat11VueExpress。 项目技术&#xff1a; Express框架 Node.js Vue 等等组成&#xff0c;B/S模式 Vscode管理前后端分离等…
阅读更多...
暂时性死区以及函数作用域

暂时性死区以及函数作用域

暂时性死区 暂时性死区也就是变量声明到声明完成的区块&#xff0c;这个区块是一个封闭的作用域&#xff0c;直到声明完成。 如果在变量声明之前使用该变量&#xff0c;那么该变量是不可用的&#xff0c;也就被称为暂时性死区。 var 没有暂时性死区&#xff0c;因为var存在变…
阅读更多...
Python编程 递归函数

Python编程 递归函数

作者简介&#xff1a;一名在校计算机学生、每天分享Python的学习经验、和学习笔记。 座右铭&#xff1a;低头赶路&#xff0c;敬事如仪 个人主页&#xff1a;网络豆的主页​​​​​​ 目录 前言 一.函数执行注意点 二.递归函数 1.递归的介绍 2.例子 前言 本章将会讲解…
阅读更多...
新版H5微信网页JS-SDK自定义分享功能实现

新版H5微信网页JS-SDK自定义分享功能实现

1.先用 微信官方文档demo&#xff0c;下载下来去改就行&#xff0c; 概述 | 微信开放文档 2.&#xff08;后端&#xff09;填写上认证后的&#xff0c;公众号appid&#xff0c;appsecret。 3.&#xff08;前端代码&#xff09; 配置好需要的接口&#xff08;调试打开debug&a…
阅读更多...
自研框架（Webx）整合Zuul网关工作总结

自研框架（Webx）整合Zuul网关工作总结

写在前面&#xff0c;最近被分配了一个技术任务&#xff0c;简单描述为自研框架&#xff08;类比Spring&#xff09;整合一个微服务网关&#xff0c;并且能用就行。 有人可能会问&#xff0c;想用微服务网关&#xff0c;不是直接引入zuul或者gateway相关的依赖&#xff0c;然后…
阅读更多...
【Pandas入门教程】如何合并多个表中的数据

【Pandas入门教程】如何合并多个表中的数据

如何合并多个表中的数据 来源&#xff1a;Pandas官网&#xff1a;https://pandas.pydata.org/docs/getting_started/intro_tutorials/index.html 笔记托管&#xff1a;https://gitee.com/DingJiaxiong/machine-learning-study 文章目录如何合并多个表中的数据导包数据准备【1】…
阅读更多...
Linux系统基础——文件子系统

Linux系统基础——文件子系统

title: Linux系统文件子系统 date: 2022-12-18 15:48:24 modify: 2022-12-18 16:48:43 author: wangjianfeng tags: 001-computer-technology, OS, Linux aliases: Linux系统文件子系统 特此说明: 刘超的趣谈linux操作系统是比较重要的参考资料&#xff0c;本文大部分内容和图…
阅读更多...
腾讯云轻量应用服务器搭建LAMP 开发环境

腾讯云轻量应用服务器搭建LAMP 开发环境

LAMP&#xff08;LinuxApacheMySQLPHP&#xff09;是目前国际流行的 Web 应用框架&#xff0c;包括了 Linux 操作系统、Apache Web 服务器、MySQL/MariaDB 数据库和 PHP 编程语言环境以及相关组件支持。 说明 LAMP 应用镜像底层基于 CentOS 7.6 64位操作系统。 登录 轻量应用服…
阅读更多...
做一个极简 UI 库之代码 lint

做一个极简 UI 库之代码 lint

eslint, prettier, stylelint 的配置 这三个规则的配置思路&#xff1a;代码美化用 prettier&#xff0c;逻辑代码用 eslint 校验&#xff0c;样式代码用 stylelint 校验。有跟代码美化冲突的以 prettier 为主 为什么要用这么多呢&#xff0c;因为 eslint 不能解析样式代码&a…
阅读更多...
数据结构---LRU算法

数据结构---LRU算法

LRU算法哈希链表自己的JAVA实现LRU全称Least Recently Used&#xff0c;也就是 最近最少使用的意思&#xff0c;是一种内存管理算法&#xff0c;该算法最早应用于Linux操作系统。这个算法基于一种假设&#xff1a;长期不被使用的数据&#xff0c;在未来被用到的几率也不大。因此…
阅读更多...
【LeetCode】1754. 构造字典序最大的合并字符串

【LeetCode】1754. 构造字典序最大的合并字符串

构造字典序最大的合并字符串 题目描述 给你两个字符串 word1 和 word2 。你需要按下述方式构造一个新字符串 merge &#xff1a;如果 word1 或 word2 非空&#xff0c;选择 下面选项之一 继续操作&#xff1a; 如果 word1 非空&#xff0c;将 word1 中的第一个字符附加到 mer…
阅读更多...
node.js+uni计算机毕设项目基于微信小程序校园生活管理LW（程序+小程序+LW）

node.js+uni计算机毕设项目基于微信小程序校园生活管理LW（程序+小程序+LW）

该项目含有源码、文档、程序、数据库、配套开发软件、软件安装教程。欢迎交流 项目运行 环境配置&#xff1a; Node.js Vscode Mysql5.7 HBuilderXNavicat11VueExpress。 项目技术&#xff1a; Express框架 Node.js Vue 等等组成&#xff0c;B/S模式 Vscode管理前后端分离等…
阅读更多...
基于形态学处理的不规则形状图像的几何参数统计，包括输出面积，周长，圆度，矩形度，伸长度

基于形态学处理的不规则形状图像的几何参数统计，包括输出面积，周长，圆度，矩形度，伸长度

up目录 一、理论基础 二、核心程序 三、测试结果 一、理论基础 形态学是图像处理中应用最为广泛的技术之一&#xff0c;主要用于从图像中提取对表达和描绘区域形状有意义的图像分量&#xff0c;使后续的识别工作能够抓住目标对象最为本质的形状特征&#xff0c;如边界和连通…
阅读更多...
C#语言实例源码系列-实现文件分割和合并

C#语言实例源码系列-实现文件分割和合并

专栏分享点击跳转>Unity3D特效百例点击跳转>案例项目实战源码点击跳转>游戏脚本-辅助自动化点击跳转>Android控件全解手册 &#x1f449;关于作者 众所周知&#xff0c;人生是一个漫长的流程&#xff0c;不断克服困难&#xff0c;不断反思前进的过程。在这个过程中…
阅读更多...
腾讯云轻量应用服务器使用 WooCommerce 应用镜像搭建电商独立站

腾讯云轻量应用服务器使用 WooCommerce 应用镜像搭建电商独立站

WooCommerce 是当前很受欢迎的电商独立站建站工具&#xff0c;具备开源、免费、使用简单且功能强大等特点&#xff0c;您可通过该镜像快速搭建基于 WordPress 的电商独立站。该镜像已预装 WordPress&#xff08;包含 WooCommerce 插件&#xff09;、Nginx、MariaDB、PHP 软件。…
阅读更多...
数据结构之排序【直接选择排序和堆排序的实现及分析】内含动态演示图

数据结构之排序【直接选择排序和堆排序的实现及分析】内含动态演示图

文章目录引言&#xff1a;1.直接选择排序2.堆排序3.直接选择排序和堆排序的测试引言&#xff1a; 感觉今天更冷了&#xff0c;码字更加的不易&#xff0c;所以引言就简单的写一下啦&#xff01;今天我们就来了解一下什么是直接选择排序和堆排序。 1.直接选择排序 时间复杂度…
阅读更多...
RabbitMQ 第一天 基础 4 RabbitMQ 的工作模式 4.1 Work queues 工作队列模式

RabbitMQ 第一天 基础 4 RabbitMQ 的工作模式 4.1 Work queues 工作队列模式

RabbitMQ 【黑马程序员RabbitMQ全套教程&#xff0c;rabbitmq消息中间件到实战】 文章目录RabbitMQ第一天 基础4 RabbitMQ 的工作模式4.1 Work queues 工作队列模式4.1.1 模式说明4.1.2 代码编写4.1.3 小结第一天 基础 4 RabbitMQ 的工作模式 4.1 Work queues 工作队列模式 …
阅读更多...
ELK第四讲之【docker安装Logstash8.4.3、集成springboot】

ELK第四讲之【docker安装Logstash8.4.3、集成springboot】

docker安装elasticsearch8.4.3 docker安装kibana8.4.3 一、docker安装logstash8.4.3 官方地址 https://github.com/elastic/logstash/releases 1、拉取镜像 docker pull elastic/logstash:8.4.3 2、启动容器 docker run -it -d --name logstash -p 9600:9600 -p 5044:…
阅读更多...
十六、Docker Compose容器编排第一篇

十六、Docker Compose容器编排第一篇

1、概述 Compose 是一个用于定义和运行多容器 Docker 应用程序的工具。使用 Compose&#xff0c;您可以使用 YAML 文件来配置应用程序的服务。然后&#xff0c;使用一个命令&#xff0c;您可以从您的配置中创建并启动所有服务。 Compose 适用于所有环境&#xff1a;生产、暂存、…
阅读更多...
node.js+uni计算机毕设项目高校自习室座位网上预约小程序（程序+小程序+LW）

node.js+uni计算机毕设项目高校自习室座位网上预约小程序（程序+小程序+LW）

该项目含有源码、文档、程序、数据库、配套开发软件、软件安装教程。欢迎交流 项目运行 环境配置&#xff1a; Node.js Vscode Mysql5.7 HBuilderXNavicat11VueExpress。 项目技术&#xff1a; Express框架 Node.js Vue 等等组成&#xff0c;B/S模式 Vscode管理前后端分离等…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023