java - Swagger:maven插件不生成Api模型

Question

我正在尝试仅使用 ApiModel 使用代码优先方法生成 YAML 和 JSON 文件。我希望 swagger-maven-plugin 只生成这个。我上面没有任何网络服务。但它不会产生任何输出。当我添加 Web 服务时，它会正确生成文件。

@ApiModel(value="BatchModel", description="Batch model for the documentation")
public class BatchD {

  private Long batchId;

  private String reference;

  private List<BatchStateD> batchStateList;

  public BatchD() {
    batchStateList = new ArrayList<>();
  }

  @ApiModelProperty(required = true, value = "The identification number of the batch.")
  @JsonProperty("id")
  @NotNull
  public Long getBatchId() {
    return batchId;
  }

  public void setBatchId(Long batchId) {
    this.batchId = batchId;
  }

  @ApiModelProperty(required = true, value = "The reference number of batch")
  @JsonProperty("reference")
  @NotNull
  public String getReference() {
    return reference;
  }

 <build>
    <plugins>
      <plugin>
        <groupId>io.swagger.core.v3</groupId>
        <artifactId>swagger-maven-plugin</artifactId>
        <configuration>
          <outputFileName>openapi</outputFileName>
          <outputPath>${project.build.directory}/generatedtest</outputPath>
          <outputFormat>JSONANDYAML</outputFormat>
          <prettyPrint>TRUE</prettyPrint>
        </configuration>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>resolve</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

Answer 1

Swagger - 它是描述 Web 服务的 API 规范。如果没有至少一个 Web 服务，就不可能有 Web 服务规范。

@ApiModel 注释仅描述 Web 服务中使用的模型的结构。如果不在 Web 服务中使用此模型，则此注释毫无用处。

因此，您将获得预期结果 - 如果您至少没有一项 Web 服务，则不存在 Swagger 规范。