swagger 如何从外部文件引用OpenAPI操作描述？

mklgxw1f 于 2022-11-06 发布在其他

关注(0)|答案(1)|浏览(152)

是否可以从外部文件引用OpenAPI操作description？
这是我的示例代码。我想把描述“This API is used to get user details”保存在一个单独的文件中，并在这里像变量或模板一样使用它，或者作为引用。有什么方法可以做到这一点吗？

get:
  tags:
    - User
  summary: Get user details
  description:  This API is used to get user details
  operationId: updateUser
  parameters:
    - name: userid
      in: path
      description: The id that needs to be pulled
      required: true
      schema:
        type: string

swagger

来源：https://stackoverflow.com/questions/74297572/how-to-reference-openapi-operation-description-from-an-external-file

1条答案

按热度按时间

zfycwa2u1#

如果你使用Redocly CLI来运行bundle，那么你可以把它放在一个单独的文件中，如下所示：

get:
  tags:
    - User
  summary: Get user details
  description: | "Description 1 here and description 2 from below ref"
    $ref: ./updateUser-description.md
  operationId: updateUser
  parameters:
    - name: userid
      in: path
      description: The id that needs to be pulled
      required: true
      schema:
        type: string

然后，在名为updateUser-description.md的单独文件中（注意，您也可以更改名称）：

This API is used to get user details

然后，当您运行bundle命令时，它会解析$ref，并将描述替换为相应Markdown文件中的内容。

npx @redocly/cli bundle my-openapi.yaml

赞(0）回复(0）举报 2022-11-06

我来回答

swagger 如何从外部文件引用OpenAPI操作描述？

1条答案

相关问题

热门标签

最新问答