Monday 12 June 2017

nested json as a request body using swagger ui in node js

I am new to node js and swagger-ui.

I want to pass below input body to my web service using swagger-ui,

I am able to pass normal json like:

{
"username":"abc",
"password":"******"
}

but I want to give following input to my web service using swagger-ui.

{
"data":
{"username":"abc",
"password":"******"
}
}

my api-docs.json file is below:

{
  "info": {
    "title": "Node Swagger API",
    "version": "1.0.0",
    "description": "Demonstrating how to describe a RESTful API with Swagger"
  },
  "host": "localhost:5002",
  "basePath": "/",
  "swagger": "2.0",
  "paths": {

    "/login": {
      "post": {
        "description": "user login",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "userName",
            "description": "username to get userType",
            "required": true,
            "type": "string",
            "in": "formData"
          },
          {
            "name": "password",
            "description": "password to get userType",
            "required": true,
            "type": "string",
            "in": "formData"
          }



        ],
        "responses": {
          "0": {
            "description": "Access token has been expired. Please login again."
          },
          "200": {
            "description": "Successfully returns the response"
          },
          "400": {
            "description": "Invalid input Parameters"
          },
          "401": {
            "description": "Invalid Access Token"
          },
          "404": {
            "description": "No data found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    }
  },
  "definitions": {},
  "responses": {},
  "parameters": {},
  "securityDefinitions": {},
  "tags": []
}

So How can pass below input using swagger-ui to my web service:

{
    "data":
    {"username":"abc",
    "password":"******"
    }
    }

Any Help will be appreciable.

Thanks In Advance.



via Shweta Dwivedi

No comments:

Post a Comment