Yaml 如何在Swagger UI中隐藏服务器描述?

Yaml 如何在Swagger UI中隐藏服务器描述?,yaml,swagger-ui,openapi,swagger-editor,oas,Yaml,Swagger Ui,Openapi,Swagger Editor,Oas,我有一个带有多个服务器的OpenAPI 3.0定义: 服务器: -网址:https://development.gigantic-server.com/v1 描述:开发服务器 -网址:https://staging.gigantic-server.com/v1 描述:临时服务器 -网址:https://api.gigantic-server.com/v1 描述:生产服务器 在Swagger UI中呈现此定义时,“服务器”下拉列表显示每个服务器的描述: 是否可以在此下拉列表中隐藏服务器描述?他

我有一个带有多个服务器的OpenAPI 3.0定义:

服务器:
-网址:https://development.gigantic-server.com/v1
描述:开发服务器
-网址:https://staging.gigantic-server.com/v1
描述:临时服务器
-网址:https://api.gigantic-server.com/v1
描述:生产服务器
在Swagger UI中呈现此定义时,“服务器”下拉列表显示每个服务器的描述:


是否可以在此下拉列表中隐藏服务器描述?

他们没有提供任何选项来在其他位置替换此服务器的
描述
,但他们提到
描述
在的swagger规范中是可选的

Swagger UI没有为此提供任何呈现选项

description
的最佳用法是用一个词来定义,如生产、开发、api、登台等

如果你真的不想在下拉列表中,那么你可以从你的服务器列表中删除它

服务器:
-网址:https://development.gigantic-server.com/v1
-网址:https://staging.gigantic-server.com/v1
-网址:https://api.gigantic-server.com/v1

我写这一部分是为了向您提供有关如何使用oas服务器的信息, 我观察了你的服务器url,这些可以很容易地在单个url中定义,如何?使用

服务器:
-url:https://{environment}.巨人服务器.com/{version}
变量:
环境:
枚举:
-“发展”
-“登台”
-“api”
版本:
枚举:
-“v1”

希望有此帮助。

Swagger UI始终呈现服务器
说明
如果提供了,这是硬编码的:

作为一种解决方法,您可以在加载API定义后动态修改它并删除服务器描述。为此,请编辑
index.html
页面,并将以下
onComplete
函数添加到Swigger UI初始化代码中:

const ui=SwaggerUIBundle({
url:“https://path/to/your/openapi.json",
...
onComplete:function(){
让spec=ui.specSelectors.specJson().toJS();
让servers=spec.servers | |[];
用于(让我进入服务器){
服务器[i]。描述=“”
}
ui.specActions.updateJsonSpec(spec);
}
})

Hi@anshulgoel,我对你的问题进行了编辑,以使其更清楚。如果这不是你的意思,请告诉我。@Helen,我只对不可编辑的YAML表示同样的意思。谢谢你提供了更多的清晰度。不,不是这样,我不能更改YAML文件。对我来说,描述即将到来,我需要将其从swagger-ui中删除。您尝试过从swagger-ui中删除吗?你能在你的问题中添加炫耀的UI配置吗?我们也可以考虑3.18版本的Sigigg。这对我也有好处。谢谢