Rest 如何为Swagger UI的身份验证令牌的头添加字段?
我的团队刚刚开始为以前由大型单片遗留应用程序处理的数据创建RESTful服务。我们想用Swagger UI记录api,我设置了一个问题Rest 如何为Swagger UI的身份验证令牌的头添加字段?,rest,service,documentation,swagger-ui,Rest,Service,Documentation,Swagger Ui,我的团队刚刚开始为以前由大型单片遗留应用程序处理的数据创建RESTful服务。我们想用Swagger UI记录api,我设置了一个问题 我需要传递一个SAML令牌作为头参数,否则,当我们尝试单击“try it out!”按钮时,会出现401身份验证错误。如何向Swagger UI添加字段,以便有人可以在请求中为要发送的SAML令牌添加字符串?这实际上非常简单。我在文档中看到了对答案的引用,但我并不真正理解它在说什么。服务URL所在位置旁边的顶部有一个字段,您可以使用该字段输入字符串作为标题值传递
我需要传递一个SAML令牌作为头参数,否则,当我们尝试单击“try it out!”按钮时,会出现401身份验证错误。如何向Swagger UI添加字段,以便有人可以在请求中为要发送的SAML令牌添加字符串?这实际上非常简单。我在文档中看到了对答案的引用,但我并不真正理解它在说什么。服务URL所在位置旁边的顶部有一个字段,您可以使用该字段输入字符串作为标题值传递。该输入字段的id为#input_apiKey 然后在index.html文件中,只需向addApiKeyAuthorization()javascript函数添加一行,告诉它获取该字段的值,并将其作为所需的任何值传递 例如:
function addApiKeyAuthorization(){
var key = $('#input_apiKey')[0].value;
if(key && key.trim() != "") {
swaggerUi.api.clientAuthorizations.add("samlToken", new SwaggerClient.ApiKeyAuthorization("samlToken", key, "header"));
swaggerUi.api.clientAuthorizations.add("Content-Type", new SwaggerClient.ApiKeyAuthorization("Content-Type", "application/json", "header"));
swaggerUi.api.clientAuthorizations.add("Accept", new SwaggerClient.ApiKeyAuthorization("Accept", "application/json", "header"));
}
}
$('#input_apiKey').change(addApiKeyAuthorization);
这将为每个请求将Content Type和Accept标头设置为相同的值,并将页面顶部绿色标头中输入字段中的值设置为my SAML标记。所以现在,如果我粘贴了一个有效的SAML字符串,我的请求就会生效,我就会得到数据 这其实很容易。我在文档中看到了对答案的引用,但我并不真正理解它在说什么。服务URL所在位置旁边的顶部有一个字段,您可以使用该字段输入字符串作为标题值传递。该输入字段的id为#input_apiKey 然后在index.html文件中,只需向addApiKeyAuthorization()javascript函数添加一行,告诉它获取该字段的值,并将其作为所需的任何值传递 例如:
function addApiKeyAuthorization(){
var key = $('#input_apiKey')[0].value;
if(key && key.trim() != "") {
swaggerUi.api.clientAuthorizations.add("samlToken", new SwaggerClient.ApiKeyAuthorization("samlToken", key, "header"));
swaggerUi.api.clientAuthorizations.add("Content-Type", new SwaggerClient.ApiKeyAuthorization("Content-Type", "application/json", "header"));
swaggerUi.api.clientAuthorizations.add("Accept", new SwaggerClient.ApiKeyAuthorization("Accept", "application/json", "header"));
}
}
$('#input_apiKey').change(addApiKeyAuthorization);
这将为每个请求将Content Type和Accept标头设置为相同的值,并将页面顶部绿色标头中输入字段中的值设置为my SAML标记。所以现在,如果我粘贴了一个有效的SAML字符串,我的请求就会生效,我就会得到数据 这其实很容易。我在文档中看到了对答案的引用,但我并不真正理解它在说什么。服务URL所在位置旁边的顶部有一个字段,您可以使用该字段输入字符串作为标题值传递。该输入字段的id为#input_apiKey 然后在index.html文件中,只需向addApiKeyAuthorization()javascript函数添加一行,告诉它获取该字段的值,并将其作为所需的任何值传递 例如:
function addApiKeyAuthorization(){
var key = $('#input_apiKey')[0].value;
if(key && key.trim() != "") {
swaggerUi.api.clientAuthorizations.add("samlToken", new SwaggerClient.ApiKeyAuthorization("samlToken", key, "header"));
swaggerUi.api.clientAuthorizations.add("Content-Type", new SwaggerClient.ApiKeyAuthorization("Content-Type", "application/json", "header"));
swaggerUi.api.clientAuthorizations.add("Accept", new SwaggerClient.ApiKeyAuthorization("Accept", "application/json", "header"));
}
}
$('#input_apiKey').change(addApiKeyAuthorization);
这将为每个请求将Content Type和Accept标头设置为相同的值,并将页面顶部绿色标头中输入字段中的值设置为my SAML标记。所以现在,如果我粘贴了一个有效的SAML字符串,我的请求就会生效,我就会得到数据 这其实很容易。我在文档中看到了对答案的引用,但我并不真正理解它在说什么。服务URL所在位置旁边的顶部有一个字段,您可以使用该字段输入字符串作为标题值传递。该输入字段的id为#input_apiKey 然后在index.html文件中,只需向addApiKeyAuthorization()javascript函数添加一行,告诉它获取该字段的值,并将其作为所需的任何值传递 例如:
function addApiKeyAuthorization(){
var key = $('#input_apiKey')[0].value;
if(key && key.trim() != "") {
swaggerUi.api.clientAuthorizations.add("samlToken", new SwaggerClient.ApiKeyAuthorization("samlToken", key, "header"));
swaggerUi.api.clientAuthorizations.add("Content-Type", new SwaggerClient.ApiKeyAuthorization("Content-Type", "application/json", "header"));
swaggerUi.api.clientAuthorizations.add("Accept", new SwaggerClient.ApiKeyAuthorization("Accept", "application/json", "header"));
}
}
$('#input_apiKey').change(addApiKeyAuthorization);
这将为每个请求将Content Type和Accept标头设置为相同的值,并将页面顶部绿色标头中输入字段中的值设置为my SAML标记。所以现在,如果我粘贴了一个有效的SAML字符串,我的请求就会生效,我就会得到数据 yaml/json规范看起来怎么样?yaml/json规范看起来怎么样?yaml/json规范看起来怎么样?yaml/json规范看起来怎么样?