java - 使用 Maven 自动为 Google Cloud Endpoints 应用生成 OpenApi 规范

Question

我使用 Java 和 Maven 框架创建了一个新的 Google Cloud Endpoints 应用。它只有一个 Servlet 和一个基本的 doGet 方法

public void doGet ... etc.

我应该能够使用以下方法生成端点文档:

mvn endpoints-framework:openApiDocs

这在 Google documentation 中有描述。

我刚刚收到一条消息，其中包含以下文本:

Generates an OpenAPI document

Usage: <Endpoints tool> get-openapi-doc <options> <service class>...

在另一个包含许多服务的现有端点项目中，运行mvn endpoints-framework:openApiDocs可以工作，我收到消息:

OpenAPI document written to C:\myFolder\my-project\target\openapi-docs\openapi.json

我需要创建一个基本的 OpenApi 文档结构。仅当我在端点中定义了服务时，mvn endpoints-framework:openApiDocs 才起作用吗？我很困惑为什么该命令有效，并在现有项目中创建一个 openapi.json ，而不是其他项目。我需要为 mvn endpoints-framework:openApiDocs 做什么来创建 openapi.json？或者可以使用 get-openapi-doc 指令以某种方式执行此操作吗？

Answer 1

我终于找到了执行此操作的 Google 文档:

Adding API Management