关于Swagger UI版本选择下拉框功能的技术咨询
关于Swagger版本切换功能的说明与实现
功能归属
“Select a definition”版本切换功能不属于OpenAPI规范的原生内容,它是Swagger UI(包含Swagger Editor)的定制化内置扩展,用来支持多版本OpenAPI定义的切换展示,实现选中对应版本后仅加载该版本的接口路由。
在Swagger Editor中实现该功能的步骤
- 准备多版本独立的OpenAPI配置文件:分别创建对应V1、V2版本的YAML/JSON文件,每个文件仅包含对应版本的接口路由、Schema等内容,比如
openapi-v1.yaml和openapi-v2.yaml。 - 本地部署的Swagger Editor配置方法:
修改Swagger Editor的配置文件(通常为swagger-editor-config.js),添加urls数组指定多版本文件路径:
重启编辑器后,顶部会自动出现版本切换下拉框。window.SwaggerEditorConfig = { urls: [ { url: "./openapi-v1.yaml", name: "V1 API" }, { url: "./openapi-v2.yaml", name: "V2 API" } ] }; - 在线Swagger Editor配置方法:
通过URL的urls参数传递多版本文件地址,在浏览器地址栏中,将多个公网可访问的OpenAPI文件URL用逗号分隔后作为urls参数的值传入,编辑器加载后顶部会自动出现版本切换下拉框,切换时仅展示对应版本的接口路由。
内容的提问来源于stack exchange,提问作者DenisNovac
相关产品推荐
相关产品推荐

