如何移除Swagger UI标题下方的API定义URL?
如何移除Swagger UI标题区域下方的API定义URL?
当然可以通过自定义index.html页面实现这个需求,下面给你两种实用的方法,你可以根据自己的情况选择:
方法1:通过CSS直接隐藏元素
这是最快速的方式,只需要在你的index.html里添加一段自定义CSS,把显示API定义URL的区域隐藏掉。Swagger UI里这个区域对应的类是swagger-ui .topbar .download-url-wrapper,具体代码如下:
<style> .swagger-ui .topbar .download-url-wrapper { display: none; } </style>
把这段代码放在index.html的<head>标签里即可,刷新页面后那个URL链接就会消失。
方法2:通过Swagger UI官方配置项控制
如果你更倾向于用官方提供的配置来实现(这种方式更规范,避免后续UI更新导致CSS选择器失效),可以在初始化Swagger UI的时候添加showDownloadUrl: false配置项。
你的初始化代码大概是这样的,只需要加上标注的那一行:
const ui = SwaggerUIBundle({ url: "your-api-spec.yaml", // 你的API定义文件地址 dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], layout: "StandaloneLayout", showDownloadUrl: false // 新增这个配置,隐藏API定义URL });
两种方法都能达到你的目的,推荐优先使用方法2,因为它是官方支持的配置方式,兼容性更好。
内容的提问来源于stack exchange,提问作者Ayyappa B
相关产品推荐
相关产品推荐

