Go语言 如何使用www.example.com生成API文档openapi-generator.tech

kqhtkvqz  于 2022-12-07  发布在  Go
关注(0)|答案(1)|浏览(84)

我正在尝试使用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终结点。
我做错了什么?
请注意,服务器运行良好,也就是说,我可以curlyaml文件中指定的端点。

fnvucqvd

fnvucqvd1#

服务器存根生成器go-gin-server似乎不支持添加这种类型的终结点。如果您查看此生成器使用的路由器模板,您会发现没有配置选项会生成/api/doc/docs终结点,除非您在规范中定义了它。
我并不清楚您希望从这个端点得到什么,但是您可以在规范中定义其中一个端点并实现您想要的行为,或者您可以自定义模板以在代码生成期间自动添加这个端点

相关问题