You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

OpenAPI v3非自托管场景下,如何隐藏Schemas区域的指定对象?

解决SwaggerHub隐藏指定Schema的方法
  • 直接用Swagger生态支持的x-hidden自定义扩展字段,这是最直接的方式。在你要隐藏的Schema定义里加上x-hidden: true即可,示例如下:
components:
  schemas:
    Customer:
      x-hidden: true
      type: object
      properties:
        id:
          type: integer
    Address:
      x-hidden: true
      type: object
      properties:
        street:
          type: string

这个配置在SwaggerHub和你使用的Swagger Editor中都能生效,标记后的Schema会从底部的Schemas列表中消失。但如果你的API接口里引用了这些Schema(比如某个接口的响应模型用到了Customer),接口文档里的请求/响应部分仍会正常显示对应的结构,只是不会单独将它们列在底部的Schemas区域。

  • 额外补充:如果某个Schema完全没被任何API接口引用,SwaggerHub默认就不会把它显示在底部Schemas里,无需额外配置。但如果是被引用了但不想单独列出来,就用上面的x-hidden方法。

内容的提问来源于stack exchange,提问作者Ryan Loggerythm

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.08 03:35:44