首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何在OpenAPI swagger UI自动生成的文档中添加externalDocs

在OpenAPI Swagger UI自动生成的文档中添加externalDocs,可以通过以下步骤完成:

  1. 在OpenAPI规范的文档中,找到要添加externalDocs的部分,通常是在paths、components或者tags中的某个具体接口或组件的定义处。
  2. 在该部分的定义中,添加一个名为"externalDocs"的字段,该字段用于描述外部文档的相关信息。
  3. 在"externalDocs"字段中,可以包含以下属性:
    • "description":对外部文档的简要描述。
    • "url":外部文档的URL地址。
  • 根据需要,填写"externalDocs"字段的属性值,例如:
  • 根据需要,填写"externalDocs"字段的属性值,例如:
  • 保存并重新生成OpenAPI规范的文档。

在Swagger UI中,添加externalDocs后,会在相应的接口或组件的文档页面中显示一个链接,用户可以点击该链接跳转到外部文档的URL地址,以获取更详细的信息。

腾讯云相关产品和产品介绍链接地址:

  • 腾讯云API网关:https://cloud.tencent.com/product/apigateway
  • 腾讯云Serverless Framework:https://cloud.tencent.com/product/sls
  • 腾讯云云函数(SCF):https://cloud.tencent.com/product/scf
页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

领券