spring boot 基础案例【4】使用Swagger2构建强大的API文档

教程1
案例教程
案例仓库
在线编程

在线编辑器运行：mvn spring-boot:run

教程2
基础教程
教程仓库
在线编程

本案例所在的仓库
本案例所在的文档

进入正文

1.文件目录

在这里插入图片描述

2.应用主类

地址:2.x/chapter2-2/src/main/java/com/didispace/chapter22/Chapter22Application.java

// 定义该类所属的包
package com.didispace.chapter22;// 导入必要的类和注解，这些来自外部的库
import com.spring4all.swagger.EnableSwagger2Doc;  // 导入注解，用于启用spring4all版本的Swagger文档
import org.springframework.boot.SpringApplication;  // 导入类，用于运行Spring Boot应用程序
import org.springframework.boot.autoconfigure.SpringBootApplication;  // 导入注解，用于简化Spring应用程序的配置// 启用Swagger 2文档，这样我们就可以通过Swagger UI查看和测试API
@EnableSwagger2Doc// 这是一个组合注解，它包含了多个Spring Boot注解，如@Configuration、@EnableAutoConfiguration和@ComponentScan
// 它通常用于主应用程序类，以简化配置并自动配置Spring应用程序
@SpringBootApplication
public class Chapter22Application {// 主方法，Spring Boot应用程序的入口点public static void main(String[] args) {// 使用SpringApplication类的run方法来启动Spring Boot应用程序// Chapter22Application.class作为应用程序上下文的源，args作为传递给应用程序的命令行参数SpringApplication.run(Chapter22Application.class, args);}}

3.pom.xml

地址：2.x/chapter2-2/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"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.3.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.didispace</groupId><artifactId>chapter2-2</artifactId><version>0.0.1-SNAPSHOT</version><name>chapter2-2</name><description>使用Swagger2构建强大的API文档</description><properties><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>com.spring4all</groupId><artifactId>swagger-spring-boot-starter</artifactId><version>1.9.0.RELEASE</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

4. 模型

地址：2.x/chapter2-2/src/main/java/com/didispace/chapter22/User.java

package com.didispace.chapter22;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;/*** 使用@Data注解来自动生成getter和setter方法，以及equals、canEqual、hashCode、toString方法。* 这个类定义了一个简单的用户实体，用于Swagger文档化。* * @ApiModelProperty注解用于描述模型属性的元数据。*/
@Data
@ApiModel(description = "用户实体")
public class User {/*** 用户编号，用于唯一标识用户。*/@ApiModelProperty("用户编号")private Long id;/*** 用户姓名，用于表示用户的姓名。*/@ApiModelProperty("用户姓名")private String name;/*** 用户年龄，用于表示用户的年龄。*/@ApiModelProperty("用户年龄")private Integer age;public User(Long id, String name, int age) {this.id = id;this.name = name;this.age = age;}}

5.控制器

地址:chapter2-2/src/main/java/com/didispace/chapter22/UserController.java

package com.didispace.chapter22;import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;import java.util.*;/*** 用户控制器，用于管理用户相关的操作。* 提供创建、获取、更新和删除用户信息的API端点。* 使用Swagger注解来增强API文档。*/
@Api(tags = "用户管理")
@RestController  // 标记该类为REST控制器，每个方法返回一个域对象而不是视图。
@RequestMapping(value = "/users") // 映射HTTP请求到MVC和REST控制器的处理方法。
public class UserController {// 创建一个线程安全的Map，模拟用户信息的存储。static Map<Long, User> users = Collections.synchronizedMap(new HashMap<>());static {User user1 = new User(1566L, "Alice", 25);User user2 = new User(2L, "Bob", 30);User user3 = new User(3L, "Charlie", 35);users.put(user1.getId(), user1);users.put(user2.getId(), user2);users.put(user3.getId(), user3);}/*** 获取所有用户列表。* * @return 用户对象列表。*/@GetMapping("/")@ApiOperation(value = "获取用户列表", notes = "返回所有用户的列表")public List<User> getUserList() {return new ArrayList<>(users.values());}/*** 创建新用户。* * @param user 请求体中的用户对象。* @return 操作成功字符串。*/@PostMapping("/")@ApiOperation(value = "创建用户", notes = "根据User对象创建用户")public String postUser(@RequestBody User user) {users.put(user.getId(), user);return "success";}/*** 获取特定用户的详细信息。* * @param id 用户的ID。* @return 具有指定ID的用户对象。*/@GetMapping("/{id}")@ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")public User getUser(@PathVariable Long id) {return users.get(id);}/*** 更新特定用户的信息。* * @param id 用户的ID。* @param user 请求体中的更新用户信息。* @return 更新操作成功字符串。*/@PutMapping("/{id}")@ApiImplicitParam(paramType = "path", dataType = "Long", name = "id", value = "用户编号", required = true, example = "1")@ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息")public String putUser(@PathVariable Long id, @RequestBody User user) {User u = users.get(id);if (u != null) {u.setName(user.getName());u.setAge(user.getAge());users.put(id, u);return "success";}return "fail";}/*** 删除特定用户。* * @param id 用户的ID。* @return 删除操作成功字符串。*/@DeleteMapping("/{id}")@ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")public String deleteUser(@PathVariable Long id) {if (users.remove(id) != null) {return "success";}return "fail";}
}

中文注释说明

这段代码已经添加了详细的中文注释，每个注释都旨在帮助读者理解代码的功能和意图。注释包括：

  • 类级别的注释：描述了UserController类的整体目的，包括它作为REST控制器的角色以及使用Swagger进行API文档增强。

  • 字段级别的注释：解释了users映射的目的，它模拟了用户信息的数据库。

  • 方法级别的注释：每个方法都附有注释，描述了方法的目的、参数和返回值。这些注释还包括了Swagger注解的相关说明。

通过这种方式添加注释，代码的可维护性和可理解性得到了显著提高，特别是对于那些可能不熟悉项目或依赖自动生成API文档来有效使用端点的开发者来说。

6. Swagger配置文件

地址：chapter2-2/src/main/resources/application.properties

这段代码是一个配置文件，用于配置Swagger的相关信息。Swagger是一个用于设计、构建和文档化RESTful风格的Web服务的工具。

下面是对这段代码的详细解释：

swagger.title=spring-boot-starter-swagger
swagger.description=Starter for swagger 2.x
swagger.version=1.9.0.RELEASE
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=didi
swagger.contact.url=http://blog.didispace.com
swagger.contact.email=dyc87112@qq.com
swagger.base-package=com.didispace
swagger.base-path=/**

  • swagger.title：Swagger文档的标题，这里设置为"spring-boot-starter-swagger"。

  • swagger.description：Swagger文档的描述，这里设置为"Starter for swagger 2.x"。

  • swagger.version：Swagger文档的版本号，这里设置为"1.9.0.RELEASE"。

  • swagger.license：Swagger文档的许可证，这里设置为"Apache License, Version 2.0"。

  • swagger.licenseUrl：Swagger文档许可证的URL，这里设置为"https://www.apache.org/licenses/LICENSE-2.0.html"。

  • swagger.termsOfServiceUrl：Swagger文档的服务条款URL，这里设置为"https://github.com/dyc87112/spring-boot-starter-swagger"。

  • swagger.contact.name：Swagger文档的联系人姓名，这里设置为"didi"。

  • swagger.contact.url：Swagger文档的联系人URL，这里设置为"http://blog.didispace.com"。

  • swagger.contact.email：Swagger文档的联系人邮箱，这里设置为"dyc87112@qq.com"。

  • swagger.base-package：指定需要生成API文档的基础包路径，这里设置为"com.didispace"。

  • swagger.base-path：指定API的基础路径，这里设置为"/**"，表示所有的API都会被包含在文档中。

通过这些配置，Swagger可以生成一个包含API接口信息的文档，方便开发人员查看和测试API。

7.效果图

http://localhost:8080/swagger-ui.html
在这里插入图片描述
在这里插入图片描述

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

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

相关文章

Secnet-智能路由系统 actpt_5g.data 信息泄露漏洞复现

Secnet-智能路由系统 actpt_5g.data 信息泄露漏洞复现

0x01 产品简介 Secnet安网智能AC管理系统是广州安网通信技术有限公司&#xff08;简称“安网通信”&#xff09;的无线AP管理系统。 0x02 漏洞概述 Secnet-智能路由系统 actpt_5g.data 接口存在信息泄露漏洞&#xff0c;未经身份验证的远程攻击者可以利用此漏洞获取系统账户…
阅读更多...
【JVM基础篇】JVM入门介绍

【JVM基础篇】JVM入门介绍

JVM入门介绍 为什么学习JVM 岗位要求 解决工作中遇到的问题 性能调优 真实案例 导出超大文件&#xff0c;系统崩溃从数据库中查询超大量数据出错消费者消费来不及导致系统崩溃Mq消息队列接受消息导致的内存泄漏业务高峰期系统失去响应 初识JVM 什么是JVM&#xff1f; JV…
阅读更多...
C 语言中怎么产生真正的随机数？

C 语言中怎么产生真正的随机数？

在C语言中&#xff0c;要产生真正的随机数&#xff0c;我们通常使用标准库中的 <stdlib.h> 头文件中提供的随机数生成函数。 这些函数可以生成伪随机数&#xff0c;但它们在一定程度上是随机的&#xff0c;足以满足大多数应用程序的需求。 1. 伪随机数生成函数 C标准库…
阅读更多...
我的notion plan

我的notion plan

阅读更多...
【verilog】上升沿判断代码

【verilog】上升沿判断代码

边沿代码
阅读更多...
Vue + Vite + Axios 项目多环境以及部署前后端跨域

Vue + Vite + Axios 项目多环境以及部署前后端跨域

最近在前端多环境和部署服务器之后出现的跨域的问题。 多环境 前端多环境 Vite Axios 1.首先在项目目录下定义多环境的文件。 这里列举开发环境和发布环境 .env.development 环境 # 开发时加载// 此处为开发时接口 VITE_API_URL http://localhost:8080/api.env producti…
阅读更多...
软考 系统架构设计师系列知识点之软件架构风格（11）

软考 系统架构设计师系列知识点之软件架构风格（11）

接前一篇文章&#xff1a;软考 系统架构设计师系列知识点之软件架构风格&#xff08;10&#xff09; 所属章节&#xff1a; 第7章. 系统架构设计基础知识 第3节. 软件架构风格 相关试题 9. “编译器”是一种非常重要的基础软件&#xff0c;其核心功能是对源代码形态的单个或一…
阅读更多...
【c++】string深度刨析以及实现

【c++】string深度刨析以及实现

#pragma once #include<iostream> using namespace std; #include<assert.h> namespace bite {class string{public://迭代器 //像指针 底层不一定是指针 typedef char* iterator;iterator begin(){return _str;}iterator end(){return _str _size;}//const 版本…
阅读更多...
网络端口占用问题的综合调研与解决方案

网络端口占用问题的综合调研与解决方案

原创 Randy 拍码场 问题背景 去年底信息安全团队进行网络权限治理&#xff0c;要求所有应用实例使用静态IP&#xff0c;公网访问策略与静态IP绑定&#xff1b;之后实例重启时偶现“端口被占用”错误。通过分析总结应用日志&#xff0c;共有以下4种错误类型&#xff0c;实质都是…
阅读更多...
kafka生产者消费者举例

kafka生产者消费者举例

文章目录 kafka介绍生产者消费者例子一、生产者二、消费者三、效果 KafkaTemplate KafkaListener kafka介绍 Kafka 是一款分布式流处理平台&#xff0c;它被设计用于高吞吐量、持久性、分布式的数据流处理。 Kafka 简介&#xff1a; Kafka 是一个高吞吐、分布式、基于发布 订阅…
阅读更多...
Emmy load workspace 排除一些目录

Emmy load workspace 排除一些目录

项目根目录新增 emmy.config.json { “source”: [ { “dir”: “./”, “exclude”: [ “Assets/Script/LuaScript/Config/.lua", "Share/DNS/Android/common/.lua”, “Assets/Script/LuaScript/UI/Team/Views/**.lua” ] } ] }
阅读更多...
深入了解 Flask Request

深入了解 Flask Request

文章目录 获取请求数据获取请求信息文件上传总结 Flask 是一个轻量级的 Python Web 框架&#xff0c;其简洁的设计和灵活的扩展性使其成为了许多开发者的首选。在 Flask 中&#xff0c;处理 HTTP 请求是至关重要的&#xff0c;而 Flask 提供了丰富而强大的 request 对象来处理…
阅读更多...
根据地址栏url上key获取值

根据地址栏url上key获取值

vue项目&#xff0c;main.js: // 根据url上key获取值&#xff0c;key为参数名字&#xff0c;例如token export function sessionIdFunc(key){ const urlSessionId new URLSearchParams(window.location.hash.slice(window.location.hash.indexOf(?))); const paramSessionI…
阅读更多...
安装InternVL

安装InternVL

InternVL 官网 interVL 安装 完全删除环境和环境中的所有软件包 conda remove -n env_name --all 安装 克隆此存储库&#xff1a; git clone https://github.com/OpenGVLab/InternVL.git 创建conda虚拟环境并激活&#xff1a; conda create -n inter pytho…
阅读更多...
SpringAop详解

SpringAop详解

文章目录 一、Spring自定义注解1、什么是注解&#x1f468;‍&#x1f3eb;2、注解的目的或作用&#x1f49e;3、JDK内置注解&#x1f4ab; 【内置元注解 一共八个固定注解】4、元注解 &#x1f3af;5、自定义注解&#x1f4f8;5、Java反射API和类加载过程51、什么是反射基本原…
阅读更多...
前端：零宽字符

前端：零宽字符

1. 概念 看不见得字符&#xff0c;称为零宽字符&#xff0c;也叫幽灵字符。 2. 作用 保护我们文章得知识产权。加文字水印&#xff0c;不影响阅读。 3. unicode 零宽字符 U200B: 空格符&#xff0c;用于较长单词得换行分隔。 U200C: 断字符&#xff0c;用于阿拉伯文、德文…
阅读更多...
GT资源-Clock资源

GT资源-Clock资源

一、Transmitter 时钟分布 XCLK&#xff1a;在使用TX buffer的模式下&#xff0c;XCLK来源于TXOUTCLK。在使用TX bypassing的模式下XCLK来源于TXUSERCLK。TXUSRCLK是GTX/GTH中PCS的内部逻辑时钟。TXUSRCLK2是GT Transceiver 用户侧逻辑时钟。 TXUSRCLK与TXUSRCLK2的关系 FPGA …
阅读更多...
Python面试题【数据结构和算法部分161-200】

Python面试题【数据结构和算法部分161-200】

Python面试题【数据结构和算法部分161-200】 Python面试题【数据结构和算法部分161-200】 Python面试题【数据结构和算法部分161-200】 问题&#xff1a;如何在Python中找到最近公共祖先&#xff08;LCA&#xff09;&#xff1f; 答案&#xff1a; class TreeNode:def __init_…
阅读更多...
ECharts系列文章汇总（持续更新中）

ECharts系列文章汇总（持续更新中）

ECharts介绍 ECharts是一款基于JavaScript的数据可视化图表库&#xff0c;提供了直观、生动、可交互、可个性化定制的数据可视化图表。以下是关于ECharts的详细介绍&#xff1a; 发展历程&#xff1a; ECharts最初由百度团队开源&#xff0c;并在2018年初捐赠给Apache基金会&…
阅读更多...
解决PL/SQL中文乱码??????

解决PL/SQL中文乱码??????

三部解决pl/sql中文乱码问题 一、查询数据库字符集 语句&#xff1a;select userenv(language) from dual 二、设置环境变量 操作&#xff1a;计算机->属性->高级系统设置->环境变量->新建环境变量名NLS_LANG&#xff0c;值是第一步查询结果。 三、重启PL/SQL&a…
阅读更多...
最新文章

Copyright @ 2022~2023