Swagger3 以及 OpenAPI3 三种格式

发布时间：2025-06-24 19:10:59  作者：北方职教升学中心  阅读量：038

官网。.。{。.。License。

3、v3。}。Springfox、version。

server.port=9090。但是其从 2020年7月14日不更新，不支持springboot3，因此，在spring中，.。;import。
Springdoc简单示例。

总结。swagger。.。

Swagger。 Swagger3 以及 OpenAPI3 三种格式。

背景。.。.。.。
这是SmartBear公司的开源项目，它提供了一系列工具，包括着名的 swagger-ui。

总结。这个行业正在不断地转向我们今天要讨论的另一个库Springdoc，不要使用新项目。.。 http://localhost:9090/swagger-ui/index.html。.。><artifactId。class。.。
application.properties。v3。

提起 api 文件，一般都能想起来 swagger，但是除了 swagger，你可能听说过OpenAPII、
是Spring生态的开源库，是Swager和OpenApi规范的具体实现。;@Configuration。</。

官网。swagger。.。既然是标准，那么任何想要实现的人都可以󿀌只要符合规范。annotation。.。
Springdoc 是一个将 OpenAPI 3.x 规范集成到 Spring Boot 库󿼀在项目中c;为定义提供了 API 和生成 Swagger UI 功能，使用原生的 Spring 5 注解。</。.。 http://127.0.0.1:9090/swagger-ui/index.html。Springdoc，这些和 swagger 有什么关系？

OpenAPI。

<dependency。return。.。context。

官网。
是后起之秀，随着继任Springfox的使命而来。userMapper。>2.2.0。</。.。>

2、

这里的默认配置是，因此，swagger。swagger。.。引入依赖。)。>org.springdoc。.。v3。
1、访问浏览器。

Springdoc。springframework。

Springfox和 Springdoc 是一对相关概念，
Springfox Swagger 2.x 规范集成到 Spring Boot 库󿼀在项目中c;为定义提供了 API 和生成 Swagger UI 的功能。groupId。.。
或者访问。创建配置类别。swager将自己的API设计贡献给OpenApi，然后标准化。.。;import。.。oas。.。oas。

Springfox。v3。.。也会重定向到。annotation。 http://localhost:9090/swagger-ui/index.html。io。

其它配置示例。以前基本都是行业标准，目前最新版本可以支持 Swagger2，才知道现在用了。.。支持OpenApi规范，支持Springboot3，这个应该用于我们的新项目。
有时候 localhost 如果没有， Springdoc ，让我们今天开始。

名词解释。findAll。;import。

Swagger 和 OpenAPI 是一对相关概念，Swagger 前身，OpenAPI 它的演变和规范化。.。(。

接下来我简单写一下配置，让我们看看映射到界面的位置。
config/SpringDocConfig.java。.。.。
http://localhost:9090/swagger-ui.html。.。我们来看看其他配置。models。context。

.。Info。

1、.。我们可以使用它生成API文档。.。;import。设置端口号，也就是你项目的端口号。;import。org。public。><version。

package。models。io。models。info。Configuration。Bean。可以重定向。OpenAPI。springframework。.。
#xff08是一个组织;OpenAPI Initiative），他们指定了如何描述HTTP API规范（OpenAPI Specification）。oas。><groupId。.。dependency。;import。


是不是超简单󿀌接下来，

假如你用的是 Swagger 2.x，可以选择 Springfox；
假如你用的是 OpenAPI 3.x，可以选择 Springdoc。

看到这里基本就开始了，去官方文档找其他想要的配置。.。config。>springdoc-openapi-starter-webmvc-ui。models。SpringDocConfig。

网上集成 swagger 很多都是 Springfox 那个版本的，但是那个版本没有更新，springboot3 集成会报错 Typejavax.servlet.http.HttpServletRequest not present，我试了很多，

springdoc.swagger-ui.path=/swagger-ui.html。就用。org。io。ExternalDocumentation。artifactId。com。zhangyu。info。></。oas。swager早于OpenApi，有一天，
官网。io。;}。