Skip to main content

Search with various query parameter styles

GET 
/search

Schema:

q:
  in: query
  schema:
    type: string
tags:
  in: query
  schema:
    type: array
    items:
      type: string
  style: form
  explode: true
filters:
  in: query
  schema:
    type: object
    properties:
      minPrice:
        type: number
      maxPrice:
        type: number
  style: deepObject
  explode: true
sort:
  in: query
  schema:
    type: array
    items:
      type: string
  style: spaceDelimited
  explode: false
fields:
  in: query
  schema:
    type: array
    items:
      type: string
  style: pipeDelimited
  explode: false

Example:

q = "openapi"
tags = ["api", "docs"]
filters = {"minPrice": 10, "maxPrice": 100}
sort = ["name", "price"]
fields = ["id", "name", "description"]
Result: /search?q=openapi&tags=api&tags=docs&filters[minPrice]=10&filters[maxPrice]=100&sort=name%20price&fields=id|name|description

Request​

Responses​

Successful response