0

在使用 Eclipse Microprofile 之前,我们已经通过io.openapitools.swagger:swagger-maven-plugin. 这个插件依赖于io.swagger.core.v3:swagger-annotationsMaven 依赖。

虽然 Eclipse Microprofile 带有不同的依赖项,但对于 openapitools 插件似乎还不够,因此生成的 open-api 文件不包含注释中提供的任何描述和其他数据。

您知道使用微配置文件依赖项生成 open-api 定义文件的方法吗?

以下是 openapitools swagger 插件的配置。

<plugin>
<groupId>io.openapitools.swagger</groupId>
<artifactId>swagger-maven-plugin</artifactId>
<version>2.1.0</version>
<executions>
    <execution>
        <id>default</id>
        <phase>verify</phase>
        <goals>
            <goal>generate</goal>
        </goals>
        <inherited>true</inherited>
        <configuration>
            <useResourcePackagesChildren>true</useResourcePackagesChildren>
            <outputDirectory>${project.build.directory}/open-api/</outputDirectory>
            <outputFormats>JSON,YAML</outputFormats>
            <prettyPrint>false</prettyPrint>

            <resourcePackages>
                <resourcePackage>...</resourcePackage>
            </resourcePackages>
            <outputFilename>...</outputFilename>
        </configuration>
    </execution>
</executions>

4

1 回答 1

0

到目前为止,我发现的唯一东西是Apache Geronimo项目创建的插件:Geronimo OpenAPI Maven 插件。他们 GitHub 页面上的示例显示了如何使用它。

<plugin>
  <groupId>org.apache.geronimo</groupId>
  <artifactId>geronimo-openapi-maven-plugin</artifactId>
  <version>${openapi.version}</version>
  <executions>
    <execution>
      <id>generate-openapi.json</id>
      <goals>
        <goal>openapi.json</goal>
      </goals>
      <configuration>
        <application>com.test.MyApp</application>
        <endpointClasses>
          <endpointClass>com.test.SomeEndpoint</endpointClass>
          <endpointClass>com.test.SomeOtherEndpoint</endpointClass>
        </endpointClasses>
        <info>
          <version>1</version>
          <title>My Title</title>
          <description>Bla Bla</description>
        </info>
      </configuration>
    </execution>
  </executions>
</plugin>

不幸的是,文档相当薄。根据依赖列表,它看起来也支持 YAML 格式。

于 2019-10-14T00:00:44.377 回答