1

我有一个简单的服务描述文件 open-api.json：

{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPI definition",
    "version": "v0"
  },
  "paths": {
    "/agents/{id}/plugins": {
      "post": {
        "tags": [
          "api-controller"
        ],
...
  },
  "components": {}
}

我在我的 Spring-webflux 项目中使用了 springdoc-openapi-webflux-ui：

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

是否可以显示现有文件而不是生成的文件？任何帮助，谢谢！

4

2 回答 2

0

如果您的文件包含 OpenAPI 3 格式的 OpenAPI 文档。然后简单地声明：（文件名可以是任何你想要的，从你声明的那一刻起）

springdoc.swagger-ui.url=/open-api.json

然后文件open-api.json，应该位于：src/main/resources/static

不需要额外的配置。

属性 springdoc.swagger-ui.configUrl，可用于此处讨论的不同用途，因为结构不同于

于 2020-08-31T10:13:38.930 回答
0

好的，这就是你需要的。

  1. 在src/main/resources 目录中，创建一个名为static的目录。在那个地方你的 open-api.json 文件。（注意- json 文件的名称可以是任何名称） [这是一个示例 open api spec json 文件]
  2. 在您的应用程序 yaml 中添加此属性：
springdoc:
  swagger-ui:
    configUrl: /open-api.json

然后启动您的应用程序并点击 URL http://localhost:8080/swagger-ui.html

请注意，如果存在 spring 安全性，则需要额外的配置。

于 2020-07-13T19:47:18.467 回答