通过gradle插件的OpenAPI codigen： UI不正确显示

Question

我正试图通过gradle插件测试openapi代码生成器。所以，我有。yml文件和文档（在中运行）https://editor.swagger.io/，看起来很酷）

openapi: 3.0.2
info:
  title: Testing docs
  version: 1.0.0
tags:
  - name: Registration
paths:
  /registration:
    post:
      tags:
        - Registration
      summary: Register user
...

这是我的一部分build.gradle

plugins {
    id "org.openapi.generator" version "5.0.1"
}

def sDir= "$buildDir/generated"
openApiGenerate {
    generatorName = "spring"
    inputSpec = "$rootDir/src/main/resources/documentation/openapi.yml"
    outputDir = "${sDir}"
    apiPackage = "generated.api"
    invokerPackage = "generated.invoker"
    modelPackage = "generated.model"
    configOptions = [
            interfaceOnly: "true",
            useTags: "true"
    ]
}
...

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-security'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springdoc:springdoc-openapi-ui:1.5.2'
    implementation 'io.springfox:springfox-swagger2:3.0.0'
    implementation 'org.openapitools:jackson-databind-nullable:0.2.1'
}

我已经用@Tag和@Api注释了大量生成的接口，实现了其中的一些，但是在/swagger用户界面上。html我看不到标签。比如，当我运行未实现的请求时，我得到了“未实现”状态，但我看不到正确的ui——它看起来是自动生成的，就像在方法上不使用任何招摇过市的注释一样。我只能认为我弄乱了一些依赖关系，但我真的找不到线索。

Answer 1

您看到的ui不是从用于生成代码的留档. yml文件生成的。相反，ui是从生成的代码中生成的，它有自己的注释，目前是springfox注释，是swagger2注释，而不是openapi 3注释（尽管您的原始文件是openapi 3）。

生成的openapi 3注释支持即将推出，但在任何情况下，简而言之，你应该自己完成丢失的注释和必要的bean，但这种方式使得很难将生成的openapi定义与原始留档文件相匹配。

幸运的是，还有一个更好的选择：只需将yml文件添加到src/main/resources/static中，然后将这一行添加到应用程序中。属性文件：

springdoc.swagger-ui.url=/<your_file>.yml

如前所述https://springdoc.org/#how-可以使用自定义jsonyml文件而不是生成的文件。您已经具有springdoc ui依赖项，因此不需要再添加任何依赖项。

这将忽略代码注释，并直接从文档生成ui。yml文件