Sping Boot 3中的springdoc-openapi-ui无法正常工作

kknvjkwl  于 2022-12-10  发布在  Spring
关注(0)|答案(1)|浏览(968)

我正在尝试将swagger-ui(OpenAPI 3.0)添加到Sping Boot v3应用程序中。
我已经添加了openapi-ui maven依赖项,它应该按照文档的要求工作。

<dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.6.11</version>
    </dependency>

但显然,它仍然不工作,localhost:8080/swagger-ui.html返回一个404错误。
我错过了什么?

8aqjt8rx

8aqjt8rx1#

根据文件:
要获得Spring启动3支持,请确保使用springdoc-openapi v2
https://springdoc.org/v2/
对于spring-boot和swagger-ui之间的集成,将库添加到项目依赖项列表中(不需要额外的配置)

<dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.0.0</version>
   </dependency>

这会自动将swagger-ui部署到一个spring-boot应用程序:
文档将以HTML格式提供,使用官方的swagger-ui jar
Swagger UI页面将在http://server:port/context-path/swagger-ui.html上提供,OpenAPI描述将在以下json格式的url上提供:http://server:port/context-path/v3/api-docs

server: The server name or IP

port: The server port

context-path: The context path of the application

Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml

请注意,模块已重新命名:

https://springdoc.org/v2/#migrating-from-springdoc-v1

相关问题