如何使用openapi-generator.tech生成API文档

Question

我正在玩https://openapi-generator.tech/，我有一个示例openapi.yaml文件：

openapi: 3.1.0

info:
  title: Sample API
  description: My amazing description.
  version: 0.0.9

servers:
  - url: http://localhost:8080/v1
    description: My amazing server description.

paths:
  /users:
    get:
      summary: Returns a list of all users.
      description: My amazing /users endpoint description.
      responses:
        "200":
          description: (OK) A JSON array of user objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string

我尝试了以下生成命令：

openapi-generator-cli generate -g go-gin-server --global-property=apiDocs=true -i ./openapi.yaml

有和没有--global-property=apiDocs=true部分。两种情况都不生成/api、/doc或/docs端点。

我做错了什么？

注意，服务器运行良好，也就是说，我可以curl yaml文件中指定的端点。

Answer 1

服务器存根生成器go-gin-server不支持添加这种类型的端点。如果查看此生成器使用的路由器模板，您可以看到，除非在规范中定义了配置选项，否则任何配置选项都不会生成/api、/doc或/docs端点。

我不清楚您对这个端点的期望是什么，但是您可以在您的规范中定义其中一个端点并实现您想要的行为，或者您可以使用自定义模板在代码生成期间自动添加此端点。