Как представить пользовательский токен в заголовке в Swagger UI (swagger.json) в nodejs - PullRequest
Новая
       13

Как представить пользовательский токен в заголовке в Swagger UI (swagger.json) в nodejs

0 голосов
/ 11 декабря 2018

Я создаю сервер Restful в ExpressJs.Я интегрировал swagger-jsdoc.Ниже приведены связанные файлы.Ниже (header.png), как я ожидаю, что мой заголовок будет выглядеть в Swagger UI.Но пока я открываю свой пользовательский интерфейс (http://localhost:3000/api-docs/),), я не могу видеть теги токенов (токен и аутентификация) в заголовке.

enter image description here

swagger.json 

{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "Viswa API"
    },
    "host": "localhost:3000",
    "basePath": "/api",
    "tags": [{
        "name": "Customers",
        "description": "API for customers in the system"
    }],
    "schemes": [
        "http"
    ],
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "securityDefinitions": {
        "Bearer": {
            "type": "apiKey",
            "name": "Authorization",
            "in": "header"
        },
        "JWT": {
            "type": "apiKey",
            "name": "token",
            "in": "header"
        }
    },
    "paths": {
        "/customer": {
            "post": {
                "tags": [
                    "Customers"
                ],
                "description": "Create new customer in system",
                "parameters": [{
                    "name": "customer",
                    "in": "body",
                    "description": "Customer that we want to create",
                    "schema": {
                        "$ref": "#/definitions/Customer"
                    }
                }],
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "201": {
                        "description": "New customer is created",
                        "schema": {
                            "$ref": "#/definitions/Customer"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "Customer": {
            "required": [
                "email"
            ],
            "properties": {
                "customer_name": {
                    "type": "string"
                },
                "customer_email": {
                    "type": "string"
                }
            }
        }
    }
}

app.route 

var apiRoutes = express.Router();
app.use('/api', apiRoutes);
// swagger definition
var swaggerUi = require('swagger-ui-express'),
swaggerDocument = require('../swagger.json');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.use('/api/v1', apiRoutes);

Текущий интерфейс Swagger:

1 Ответ

0 голосов
/ 27 декабря 2018

Вам не хватает тега безопасности.Вы можете определить его глобально чуть ниже тега securityDefinitions или по одному для каждой конечной точки API.

Посмотрите на этот вопрос.

...