当前位置：首页 > news >正文

SpringBoot集成swagger和jwt

news 2025/7/17 15:35:47

一、集成swagger文档

1.简介

2.OpenAPI3集成swagger文档

3.springfox集成swagger

二、集成JWT

一、集成swagger文档

为了方便后端人员进行进行接口测试，swagger就此诞生

1.简介

API 文档自动生成

减少文档编写工作：通过在代码中使用注解，Swagger 可以自动生成详细的 API 文档，减少了手动编写文档的工作量。
保持文档与代码同步：由于文档是直接从代码生成的，因此可以确保文档总是与实际的 API 实现保持一致。

交互式 API 测试

实时测试 API：Swagger UI 提供了一个基于浏览器的界面，允许开发者直接从浏览器调用 API 并查看响应结果，这有助于快速测试 API 功能。
参数输入与验证：用户可以直接在界面上输入参数并发送请求，Swagger 会自动处理参数格式和验证。

API 设计和开发协作

统一的 API 规范：Swagger 使用 OpenAPI 规范（以前称为 Swagger 规范），这是一种标准的 API 描述格式，使得团队成员可以更容易理解和遵循 API 设计。
前后端分离开发：前端和后端开发者可以通过 Swagger 文档进行沟通，即使在后端 API 还未完成时，前端也可以开始基于文档进行开发。

2.OpenAPI3集成swagger文档

OpenAPI 3 是最新的swagger文档标准，它提供了更好的功能和支持。此外，OpenAPI 3 增加了许多新特性，如改进的安全性描述、回调定义等，这些都是旧版本所不具备的。SpringBoot3项目推荐使用此版本。

导入依赖

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.3.0</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.15.2</version> 
        </dependency>

文档配置

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import o

查看全文

http://www.dtcms.com/a/111356.html