Forum Discussion

rahuldwivedi's avatar
rahuldwivedi
New Contributor
5 years ago

JTW token is not getting passed in Swagger-ui

JWT token is not getting passed under 'Authorization' feild. Here's the full post https://stackoverflow.com/questions/63119252/jtw-token-is-not-getting-passed-in-swagger-ui
JWT
swagger
Swagger-ui
  • HKosova's avatar
    HKosova
    5 years ago

    Hi rahuldwivedi,

    Make sure your API definition includes the "security" key on the root level or in operations. For example:

    swagger: '2.0'
securityDefinitions:
  ApiKeyAuth:
    type: apiKey
    in: header
    name: Authorization
security:  # <-------------
  - ApiKeyAuth: []

    Check out our OpenAPI 2.0: API Keys guide for more examples.

  • HKosova's avatar
    HKosova
    5 years ago

    Replace

        "security":{
        "ApiKeyAuth": []
    },

    with

      "security": [
    {
      "ApiKeyAuth": []
    }
  ],

     

    Swagger Editor is a YAML editor, but you can also paste JSON and import JSON files. JSON will be automatically converted to YAML. Then after you fixed the errors you can use the "File > Convert and save as JSON" command to export back to JSON.

rahuldwivedi's avatar
rahuldwivedi
New Contributor
HKosova  I looked into that editor, but it looks like this is using .yaml  only. I pasted my swagger.json on the editor and it showed an error, "security should be an array".  Here's the complete code. How should I modify the security field?
 
{
    "swagger": "2.0",
    "info": {
      "version": "1.0.0",
      "title": "Magic 8 ball App API",
      "description": "Find out how your APIs work",
      "license": {
        "name": "MIT",
        "url": "https://opensource.org/licenses/MIT"
      }
    },
    "host": "localhost:3000",
    "tags": [
      {
        "name": "Users",
        "description": "API for users in the system"
      }

 

    ],
    "schemes": [
      "http",
      "https"
    ],
    "consumes": [
      "application/json"
    ],
    "produces": [
      "application/json"
    ],
    "securityDefinitions": {
        "ApiKeyAuth":{
            "type": "apiKey",
            "name": "Authorization",
            "in": "header"
        }
    },
    "security":{
        "ApiKeyAuth": []
    },
    "paths": {
      "/api/eight-ball/user/login": {
        "post": {
          "summary": "Login user",
          "tags": [
            "Users"
          ],
          "description": "Login user in system",
          "parameters": [
            {
              "name": "user",
              "in": "body",
              "description": "Login user",
              "schema": {
                "$ref": "#/definitions/User"
              }
            }
          ],
          "produces": [
            "application/json"
          ],
          "responses": {
            "200": {
              "description": "Login Success",
              "schema": {
                "$ref": "#/definitions/User"
              }
            },
            "401":{
              "description": "Login details are not valid!!"
            },
            "404":{
              "description": "Email is not registered!"
            },
            "500":{
              "description": "User login failed!!"
            }
          }
        }
      }
    },

 

    "definitions": {

 

      "User": {
        "properties": {
          "email": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        }
      },
      "userEmail":{
        "properties": {
          "email": {
            "type": "string"
          }
        }
      }
    }
  }
 
 
The relevant code at node js:


const swaggerDocument = require('./swagger.json');
const swaggerUi = require('swagger-ui-express');
 
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
HKosova's avatar
HKosova
SmartBear Alumni (Retired)
5 years ago

Replace

    "security":{
        "ApiKeyAuth": []
    },

with

  "security": [
    {
      "ApiKeyAuth": []
    }
  ],

 

Swagger Editor is a YAML editor, but you can also paste JSON and import JSON files. JSON will be automatically converted to YAML. Then after you fixed the errors you can use the "File > Convert and save as JSON" command to export back to JSON.