当前位置: 首页 > 知识库问答 >
问题:

如何更改swagger-ui路径以打开自定义留档?

南门鸿振
2023-03-14

我正试图使用OpenAPI3.0(版本1.5.0)记录我的RESTAPI。我的问题是,如何更改swagger url以重定向到我的自定义文档?

这是我当前的application.yml文件:

  api-docs:
    path: /custom/api-docs
  swagger-ui:
    path: /custom/swagger
    config-url: /custom/api-docs

如果我尝试启动我的应用程序并使用以下链接访问swagger文档:https://localhost:8080/custom/swagger

我被重定向到https://localhost:8080/custom/swagger-用户界面/索引。html?configUrl=/custom/api文档

这将打开Petstore文档,而不是我的自定义文档。

如果我在URL中手动键入此项:https://localhost:8080/custom/swagger-用户界面/索引。html?url=/custom/api docs(将configUrl更改为url)它打开了我的自定义文档。

我想实现的是可能的吗,那就是打字的时候https://localhost:8080/custom/swagger它打开了我的自定义招摇过市文档,而不是Petstore文档?

如果这很重要,这是我的依赖:

<!-- Springdoc for OpenAPI 3 -->
 <dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.5.0</version>
 </dependency>

共有1个答案

应和悦
2023-03-14

斯普林多克。大摇大摆的用户界面。configUrl与您的配置不相关。

这是相关的是您有一个外部配置文件,如留档中所述:

  • https://springdoc.org/#swagger-ui-properties
 类似资料:
  • 我已经尝试更改json文件中的basePath,这似乎只会更改swagger UI的底部“baseurl”。我想去掉在我的招摇过市UI中作为组标题出现的“默认设置”。有人能解决这个问题吗?我正在使用Swagger~2.0。

  • 我正在使用Swagger为Spring boot2微服务创建API留档,我是Swagger的新手。我的Spring启动应用程序具有上下文路径 /api/user/因此该应用程序可在localhost:8080/api/user访问。swagger默认用户界面可在/swagger-ui.html访问。所以从我的项目来看,网址是localhost:8080/api/user/swagger-ui.ht

  • 通过添加这个SwaggerConfig文件并添加以下依赖项,我可以将swagger2设置到我的SpringBoot应用程序中: pom.xml 尽管我的controller类看起来像这样: ...我仍然可以通过执行以下操作来调用该控制器: RESTendpoint的curl-x GET如下所示: 看来spring-boot只是在浏览器中使用简单的旧版http://localhost:8080作为s

  • 我使用的是Spring Boot 1.3.3和swagger springmvc:1.0.2。我正在将应用程序的基本路径设置为“/”。而斯威格正在 http://localhost:9000/swagger/index.html 我需要更改它,但将应用程序的根目录保留为“/”。我需要写一条规则,比如: 如果有人打http://localhost:9000/SOMETHING/swagger/ind

  • 我正在运行一个服务,其中可以访问Swagger UI: 但是,它背后是一个代理,比如: Swagger UI生成的URL如下所示: