我已经使用springdoc安装了OpenAPI 3，但是网址很奇怪。我能把它改成期望值吗？

Question

我在Java项目的pom文件中使用以下构件安装了swagger ui：

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

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-security</artifactId>
      <version>1.5.2</version>
   </dependency>

当我转到这个URL时，我可以查看RESTfulendpoint的招摇过市ui

http://localhost:8081/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

但不是这个链接

http://localhost:8081/swagger-ui/index.html

这是为什么呢？如何将其更改回预期的URL？

Answer 1

您需要在http://localhost:8081/swagger-ui.html访问swagger ui，而不是加载宠物店默认swagger的http://localhost:8081/swagger-ui/index.html。你可以检查周围的工作在

https://github.com/springdoc/springdoc-openapi/issues/43

urlhttp://localhost:8081/swagger-用户界面。html将始终被重定向到http://localhost:8081/swagger-用户界面/索引。html？configUrl=/v3/api文档/swagger配置。

您可以自定义以下application.properties

springdoc.api-docs.path=/api-docs 
springdoc.swagger-ui.path=/swagger-ui-custom.html

现在urlhttp://localhost:8081/swagger-用户界面自定义。html将被重定向到http://localhost:8081/swagger-用户界面/索引。html？configUrl=/api文档/swagger配置。

Answer 2

首先，下面的依赖关系与您提到的问题无关。

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-security</artifactId>
    <version>1.5.2</version>
</dependency>

现在来回答你的问题。

网址http://localhost:8081/swagger-用户界面/索引。html来自于构建Springdoc的Swagger核心库，因此它将提供默认的Petstore示例。尽管可以使用应用程序中的以下属性禁用此页面。属性文件。

springdoc.swagger-ui.disable-swagger-default-url=true

但这只适用于v1.4.1及以上版本。

现在在URlhttp://localhost:8081/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config查询参数confiUrl指定从哪里获取Springdoc特定于Swagger的配置文件。

现在如果你真的点击了网址http://localhost:8081/v3/api-docs/swagger config，您将得到一个与下面类似的配置文件

{
  "configUrl": "/v3/api-docs/swagger-config",
  "docExpansion": "none",
  "urls": [
    {
      "url": "/v3/api-docs/default",
      "name": "default"
    }
  ],
  "validatorUrl": ""
}

url对象包含每个API组的各个对象。每个API组都显示在Swagger UI中，如下所示

现在，对于每个API组，Springdoc使用这些属性通过从给定的url获取OpenAPI规范文件来呈现Swagger-UI，并且name如上图所示呈现。

至于docExpansion属性，它被设置为none，因为该设置是在我的应用程序中明确指定的。属性

• 如果要覆盖从中获取Springdoc的Swagger配置文件的URL，请使用以下属性。基本上，新URL应该返回一个与/v3/api docs/swagger config返回的配置文件类似的配置文件。默认设置为/v3/api文档/swagger配置

springdoc.swagger-ui.configUrl=/mySpringdocConfig

• 使用以下属性覆盖Springdoc的招摇过市UI加载的URL。默认为/swagger用户界面。html，这就是为什么在http://localhost:8081/swagger-用户界面。html

springdoc.swagger-ui.path=/mySwagger-UIPath

>

我认为不可能摆脱？从URL中配置Url=/v3/api-docs/swagger-config，因为它将始终可用，并指向将从其中获取Sprinfdoc配置文件的位置，如果不可用，将导致在获取配置文件时出错，从而使Swagger-UI没用的。此外，这是您不想删除的东西，因为它正被框架本身使用。

请参阅此处，获取所有支持的属性列表，以自定义Springdoc的行为。