Swagger API which is having query string

Question

I want to deploy an API which is having query string.This is the API

v1/products?q=circuit breaker&locale=en-GB&pageSize=8&pageNo=1&project=GLOBAL

Here is how i am implementing

"/v1/products?q={searchText}&locale={ctrCode}&pageSize={pageSize}&pageNo={pageNo}&project={project}&country={country}":{  
         "get":{  
            "tags":[  
               "Search Text"
            ],
            "summary":"Get Products by searching text, countrycode, page number, pagesize, project and country(optional)",
            "description":"Get Products by searching text, countrycode, page number, pagesize, project and country(optional)",
            "operationId":"getProductName",
            "produces":[  
               "application/json",
               "application/xml"
            ],
            "parameters":[  
               {  
                  "name":"searchText",
                  "in":"path",
                  "description":"The Product that needs to be fetched",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"ctrCode",
                  "in":"path",
                  "description":"The Product locale needs to be fetched. Example=en-GB, fr-FR, etc.",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"pageSize",
                  "in":"path",
                  "description":"The Product PageSize that needs to be fetched. Example=10, 20 etc.",
                  "required":true,
                  "type":"number"
               },
               {  
                  "name":"pageNo",
                  "in":"path",
                  "description":"The Product pageNo that needs to be fetched. Example=1,2 etc.",
                  "required":true,
                  "type":"number"
               },
               {  
                  "name":"project",
                  "in":"path",
                  "description":"The Project that needs to be fetched. Example=Mypact, DSL etc.",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"country",
                  "in":"header",
                  "description":"The Country that needs to be fetched. Example=France, India etc.",
                  "required":false,
                  "type":"string"
               }
            ],
            "responses":{  
               "200":{  
                  "description":"successful operation",
                  "schema":{  
                     "$ref":"#/definitions/Products"
                  }
               },
               "400":{  
                  "description":"Invalid Product_id supplied"
               },
               "404":{  
                  "description":"Product not found"
               }
            }
         }
      }

The country is optional parameter in this. I want the URL should display country only when if user enter some value, else it should not be displayed in the URL.

same problem...swagger is stupid here...

gouchaoer
– gouchaoer

2017-01-12 07:18:36 +00:00
Commented Jan 12, 2017 at 7:18 — gouchaoer
– gouchaoer, Commented Jan 12, 2017 at 7:18

Ron · Accepted Answer · 2015-05-15 11:14:38Z

You can't describe query parameters as part of the path in Swagger. You have to declare those explicitly as query parameters.

"/v1/products":{  
         "get":{  
            "tags":[  
               "Search Text"
            ],
            "summary":"Get Products by searching text, countrycode, page number, pagesize, project and country(optional)",
            "description":"Get Products by searching text, countrycode, page number, pagesize, project and country(optional)",
            "operationId":"getProductName",
            "produces":[  
               "application/json",
               "application/xml"
            ],
            "parameters":[  
               {  
                  "name":"searchText",
                  "in":"query",
                  "description":"The Product that needs to be fetched",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"ctrCode",
                  "in":"query",
                  "description":"The Product locale needs to be fetched. Example=en-GB, fr-FR, etc.",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"pageSize",
                  "in":"query",
                  "description":"The Product PageSize that needs to be fetched. Example=10, 20 etc.",
                  "required":true,
                  "type":"number"
               },
               {  
                  "name":"pageNo",
                  "in":"query",
                  "description":"The Product pageNo that needs to be fetched. Example=1,2 etc.",
                  "required":true,
                  "type":"number"
               },
               {  
                  "name":"project",
                  "in":"query",
                  "description":"The Project that needs to be fetched. Example=Mypact, DSL etc.",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"country",
                  "in":"query",
                  "description":"The Country that needs to be fetched. Example=France, India etc.",
                  "required":false,
                  "type":"string"
               }
            ],
            "responses":{  
               "200":{  
                  "description":"successful operation",
                  "schema":{  
                     "$ref":"#/definitions/Products"
                  }
               },
               "400":{  
                  "description":"Invalid Product_id supplied"
               },
               "404":{  
                  "description":"Product not found"
               }
            }
         }
      }

that is not my problem , the problem is if user does not give anything for country(parameter) the country={country} should not be displayed in the URL
You are right, I forget a certain fix. Edited to reflect that.

Akolade Adesanmi · Accepted Answer · 2019-01-06 14:09:02Z

10

Your IN parameter needs to be "query" not "path"

This should work:

"parameters": [
  {  
    "name":"country",
    "in":"query",
    "description":"The Country that needs to be fetched. Example=France, India etc.",
    "required":false,
    "type":"string"
  }
]

edited Jan 6, 2019 at 14:09

Akolade Adesanmi

1,26012 silver badges17 bronze badges

answered Aug 23, 2016 at 11:53

Mohammedshafeek C S

1,9432 gold badges18 silver badges26 bronze badges

Comments

ekimas · Accepted Answer · 2022-01-17 09:41:20Z

In editor.swagger.io you can do it like that:

no params in your routing
params' attribute 'in' has to be 'query'

/v1/products:  
  get:
    tags:
       - Search Text       
    summary: Get Products by searching text, countrycode, page number, pagesize, project and country(optional)
    description: Get Products by searching text, countrycode, page number, pagesize, project and country(optional)
    operationId: getProductName
    parameters: 
      - name: searchText
        in: query
        description: The Product that needs to be fetched
        required: true
        schema:
          type: string
      - name: ctrCode
        in: query
        description: The Product locale needs to be fetched. Example=en-GB, fr-FR, etc.
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        description: The Product PageSize that needs to be fetched. Example=10, 20 etc.
        required: true
        schema:        
          type: number
      - name: pageNo
        in: query
        description: The Product pageNo that needs to be fetched. Example=1,2 etc.
        required: true
        schema:
          type: number
      - name: project
        in: query
        description: The Project that needs to be fetched. Example=Mypact, DSL etc.
        required: true
        schema:
          type: string

Collectives™ on Stack Overflow

Swagger API which is having query string

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related