2025年swagger2配置（swagger 2.0）

大家好，我是讯享网，很高兴认识大家。

 <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path> </svg> <blockquote>

讯享网

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

使用Swagger 2是为了解决前后端接口之间的交互问题

Swagger 2由以下几个主要组成部分组成：

讯享网

Swagger规范（Swagger Specification）：它是一种基于JSON或YAML格式的文档，定义了API的各个方面，如接口、路径、参数、响应等。Swagger规范可以作为API文档的基础，同时也可以通过Swagger工具生成交互式的API文档。

Swagger注解（Swagger Annotations）：在Java中，你可以使用Swagger注解来标记API接口、参数、响应等，以便将其与Swagger规范进行关联。这些注解提供了额外的元数据，帮助Swagger生成正确的API文档。

Swagger UI：这是一个交互式的API文档生成工具，可以根据Swagger规范生成漂亮、可交互的API文档界面。Swagger UI提供了一个用户友好的方式来查看和测试API，包括请求参数的输入和响应结果的查看。

Swagger编辑器（Swagger Editor）：这是一个在线的Swagger规范编辑器，可以帮助你编写和验证Swagger规范。它提供了实时的语法检查、自动完成和格式化等功能，使得编写Swagger规范更加便捷。

使用Swagger 2，你可以通过编写Swagger规范和使用Swagger注解来描述和定义你的API。然后，你可以使用Swagger工具集来生成交互式的API文档，并且可以通过Swagger UI来浏览和测试API。

现在还可以选择使用openapi 3.0，相较于swagger2来说，openai优化了其缺点：对代码有严重的侵入式,不可维护,需要在控制层写很多不必要的代码
详细文档可以参考 :
码小呆~大佬的文章《 OPENAPI3.0 与 SpringBoot 开发实战:
新型高效开发模式,实现代码与API分离,高效开发,开发必看!!!》

创建Swagger2Config文件
在这里插入图片描述

以下是Swagger2Config代码：

讯享网

后面扩展的方法是为了实现这两个方法

我们需要了解这两个方法的作用：

securityContexts 和 securitySchemes 是用于配置 Swagger 文档中的安全认证信息的两个关键部分。

securityContexts：安全上下文
securityContexts 方法用于配置需要进行安全认证的路径和相应的安全引用。
通过创建 SecurityContext 对象，可以指定哪些 API 接口需要进行安全认证。
使用 forPaths(PathSelectors.regex(pathRegex)) 方法指定符合特定路径正则表达式的接口需要进行安全认证。
使用 securityReferences(defaultAuth()) 方法指定使用哪种安全引用进行认证，即指定认证方案。

securitySchemes：安全方案

securitySchemes 方法用于配置 API 访问时使用的安全方案，例如认证头信息等。
通过创建 SecurityScheme 对象，可以指定不同的安全方案。
一种常见的安全方案是使用认证头信息，可以通过创建 ApiKey 对象来表示认证头信息的配置。
通过将创建的安全方案添加到列表中，并返回给 Docket 对象的 securitySchemes() 方法，来配置安全方案。
通过配置 securityContexts 和 securitySchemes，Swagger 将在生成的文档中包含相应的安全认证信息，帮助用户了解哪些接口需要进行认证以及如何进行认证。这样可以增加 API 文档的可用性和安全性，同时方便开发者在使用 API 时进行正确的认证操作。

2025年swagger2配置（swagger 2.0）

相关推荐