2

我正在尝试在 micronaut swagger UI 中合并附加文件模式。我认为该文件在构建期间没有被拾取，很不确定如何为附加文件设置正确的路径。

在资源内部存在附加文件

在此处输入图像描述

在 application.yml 配置中，我设置了以下配置

micronaut:
  openapi:
    additional:
      files= src/main/resources/swagger/swaggerSecuritySchemes.yml

swaggerSecuritySchemes.yml

securitySchemes:
  Open Id Connect:
    type: oauth2
    flows:
      authorizationCode:
        authorizationUrl: https://falconidentityserver.azurewebsites.net/connect/authorize
        tokenUrl: https://falconidentityserver.azurewebsites.net/connect/token
        refreshUrl: ""
        scopes:
          openid: Open Id scope
          profile: Name scope
          email: Email scope
        usePkceWithAuthorizationCodeGrant: true

在 build swagger yml 文件中，那些配置不存在，我认为在构建过程中没有选择文件，我们如何设置附加文件的路径

来自 micronaut 文档

micronaut.openapi.additional.files={project.home}/src/test/resources/swagger

什么是project.home？

我在 build.gradle 文件中尝试了以下代码，但它没有合并其他文件中的任何内容

tasks.withType(JavaCompile).all {
    options.fork = true
    options.forkOptions.jvmArgs << '-Dmicronaut.openapi.views.spec=swagger-ui.enabled=true,swagger-ui.theme=MATERIAL'
    options.forkOptions.jvmArgs << '-Dmicronaut.openapi.additional.files=src/main/resources/swagger'
    options.compilerArgs += ['--enable-preview']
}

更新 1

components:
  securitySchemes:
    Open Id Connect:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://falconidentityserver.azurewebsites.net/connect/authorize
          tokenUrl: https://falconidentityserver.azurewebsites.net/connect/token
          refreshUrl: ""
          clientId: xxxxxxxxxx
          clientSecret: xxxxx-xxxxxxxxxxxxx
          scopes:
            openid: Open Id scope
            profile: Name scope
            email: Email scope
          usePkceWithAuthorizationCodeGrant: true

包括上面的定义合并了配置，但是在最终文档中clientId，clientSecret和usePkceWithAuthorizationCodeGrant没有合并，为什么？

4

2 回答 2

0

正如文档所述，按顺序：

要配置其他 swagger 文件的路径，您需要设置系统属性 micronaut.openapi.additional.files

micronaut.openapi.additional.files应将其添加为构建的系统属性，因为OpenAPI文档是在构建/编译时而不是在运行时生成的，因此将此属性添加到application.yml（运行时）配置将无效。

摇篮：

如果您使用的是gradle，则可以添加此micronaut.openapi.additional.files属性：

  • 启动构建时的命令行系统属性：

    $ ./gradlew build -Dmicronaut.openapi.additional.files=src/main/resources/swagger

  • 到您的项目gradle.properties从而避免在每次构建时添加System 属性：

    systemProp.micronaut.openapi.additional.files=src/main/resources/swagger

马文：

如果您使用的是maven，则可以添加该micronaut.openapi.additional.files属性：

  • 启动构建时也可以到命令行系统属性：

    $ mvn clean compile -Dmicronaut.openapi.additional.files=src/main/resources/swagger

  • 到您的项目描述符pom.xml作为项目属性，从而避免在每次构建时添加System 属性：

    <properties>
    <micronaut.openapi.additional.files>src/main/resources/swagger</micronaut.openapi.additional.files>
</properties>

边注

请注意，在两个构建工具配置中，该micronaut.openapi.additional.files属性都指向目录路径（src/main/resources/swagger）而不是文件路径，因为文档没有提到该属性将目录而不是显式文件作为其值。

据我所知，附加文件不支持securitySchemes声明，只会合并paths文档。但我可能错过了一些细节，否则可以随意在micronaut-openapi存储库中引发问题。

于 2021-01-15T11:48:48.490 回答
0

这对我有用，试试这个：

openapi步骤1：在根目录中创建一个名为的文件夹。

第 2 步：然后在它自己的 openapi 文件夹中手动创建您的 yml，并schemas根据(OpenAPI specification).

第 3 步：现在将两个文件与generated OpenAPI definition. 您需要指向 Micronaut 以OpenAPI在 openapi 文件夹中查找其他 yaml 文件。因此，您需要设置属性 micronaut.openapi.additional.files

将 micronaut 指向 openapi 文件夹：

步骤1：openapi.properties在根目录中查找文件。如果该文件不存在，则创建一个。

第2步：一旦我们将文件粘贴到文件中->micronaut.openapi.additional.files=openapi

确认：在此过程之后确认 micronaut 是否实际上正在合并文件。在服务器启动时注意日志...

如果该过程成功，您应该能够看到这些：-

Note: Merging Swagger OpenAPI YAML files from location: whateverDirectory/openapi
Note: Reading Swagger OpenAPI YAML file YourFileName.yml
于 2021-05-24T01:53:48.857 回答