Question

如何将http://localhost:3000/resources/api/?key=aslkdajd1323121lklakskdl形式的基本网址传递给swagger ui？

我能够访问http://localhost:3000/resources/api但是当我添加auth过滤器并传递密钥时，它会显示Unauthorized。

使用swagger 1.X

通过index.html中的apiKeyauthorization预填充参数没有帮助，但是当我在UI中键入键时，它起作用了。无法理解其原因。希望有人可以帮助我理解它。

Answer 1

Try this swagger 2.0 file (use http://studio.restlet.com to downgrade to version 1.2) :

{
    "swagger": "2.0",
    "info": {
        "version": "0.0.1",
        "title": "Todo App"
    },
    "host": "localhost:3000",
    "schemes": [
    "http"
    ],
    "paths": {
        "/resources/api": {
            "post": {
                "parameters": [
                    {
                        "name": "key",
                        "in": "query",
                        "description": "key",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful response"
                    }
                }
            }
        }
    }
}

Answer 2

我能够通过添加来解决这个问题 window.authorizations.add("key", new ApiKeyAuthorization("key", yourKeyValue, "query"));

在SwaggerUI构造函数中 window.swaggerUi = new SwaggerUi({ . . .

在声明之前 window.swaggerUi.load()

Answer 3

您只需要使用javscript从url获取参数。在文件“index.html”中，在swagger-ui / dist文件夹下，添加这样的内容以获取密钥：

var key = window.location.search.match(/key=([^&]+)/);

您可以在我的GIST中看到一个简单的示例。

Swagger ui url带参数

3 个答案: