Java Maven openapi/swaggerui 生成文件脚本

Question

我有一个用 Java Springboot + Maven 构建的项目。 我正在尝试提供一个仅供内部使用的开放 api 文档，因此它不是公开托管的。 它目前在构建时会生成一个 openapi 文件，但它会导致管道中出现一些问题。 有没有办法将其配置为仅在我运行特定脚本时生成新文件？

我目前有 springdoc-openapi-ui 的 1.4.8 版本。

提前致谢！

Answer 1

我认为您可以在pom.xml中指定配置文件来执行此操作

  <profiles>
    <profile>
      <id>generate-doc</id>
      <build>
        <plugins>
          <plugin>
    ...
          </plugin>
        </plugins>
      </build>
    </profile>
  </profiles>

然后你可以使用mvn clean install -Pgenerate-doc运行它来生成你的文件。

Answer 2

如果您使用的是 Maven，您可以在 pom.xml 中设置 org.springdoc（我有同样的错误，所以我从 io.springfox 更改为 org.springdo）：

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>3.0.0</version>
    </dependency>

您可以使用 ：

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