文章/答案/技术大牛

发布

社区首页 >问答首页 >如何从外部文件引用OpenAPI操作描述？

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

Stack Overflow用户

提问于 2022-11-03 02:27:11

回答 1查看 50关注 0票数 1

是否可以从外部文件引用OpenAPI操作description？

这是我的代码样本。我希望将描述“--此API用于获取用户详细信息”保留在一个单独的文件中，并将其作为变量或模板或引用在这里使用。有办法这样做吗？

 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

yaml

swagger

openapi

redocly

回答 1

Stack Overflow用户

回答已采纳

发布于 2022-11-03 02:48:21

如果您对捆绑使用Redocly，那么您可以将它放在一个单独的文件中，如下所示：

 get:
  tags:
    - User
  summary: Get user details
  description: 
    $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

票数 2

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/74297572

复制

相似问题

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

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

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

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

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