如何在应用程序url/swagger上显示静态swagger yaml文件

Question

我创建了yaml文件（openapi 3.0.0格式）作为API的文档。我想在应用程序运行的URL处显示这个（静态）swagger-ui yaml文件。类似于http://localhost:8080/swagger-ui。其中显示了yaml文件的图形表示（与此处相同）。Yaml文件放在Project的根文件夹中。

我在Java11，springboot 2.1.5上运行应用程序，用Maven构建。

我尝试从代码生成swagger yaml

    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
    </dependency>

Answer 1

您还需要添加swagger UI依赖项。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

然后您可以使用，

http://localhost:9090/swagger-ui.html#/

尝试将此添加到您的方法中，

public void yourMethod(@ApiParam(name = "id", required = true, value = "The id of the site", defaultValue = "3F7B07E2") String id)