This is an example of an OpenAPI document with security definitions and security requirements.
Servers
https://localhost:3000Local server
GET /onlyApiKey
POST /onlyBearerAuth
POST
/onlyBearerAuth
Authorizations
bearerAuth
TypeHTTP (bearer)
Example
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30
PUT /apiKeyAndBearerAuth
PUT
/apiKeyAndBearerAuth
Authorizations
apiKey
TypeAPI Key (header: api_key)
Example
your-api-key
bearerAuth
TypeHTTP (bearer)
Example
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30
Parameters
Header Parameters
headerParam*
Header parameter description
Typestring
RequiredExample
value
GET /apiKeyOrBearerAuth/{pathParam}
GET
/apiKeyOrBearerAuth/{pathParam}
Authorizations
apiKey
TypeAPI Key (header: api_key)
Example
your-api-key
or
bearerAuth
TypeHTTP (bearer)
Example
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30
Parameters
Path Parameters
pathParam*
Path parameter description
Typestring
RequiredPOST /multipleSecurity/{pathParam}
POST
/multipleSecurity/{pathParam}
Authorizations
apiKey|bearerAuth +
apiKey
TypeAPI Key (header: api_key)
Example
your-api-key
bearerAuth
TypeHTTP (bearer)
Example
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30
or
basicAuth|internalApiKey +
basicAuth
Basic authentication with username and password
TypeHTTP (basic)
internalApiKey
Internal API key for special customers
TypeAPI Key (header: internal_api_key)
Example
special-key
Parameters
Path Parameters
pathParam*
Path parameter description
Typestring
RequiredQuery Parameters
param1*
Query parameter description
Typestring
RequiredEnum
value1
value2
default
value1
param2*
Another query parameter description
Typestring
RequiredRequest Body
application/json
{
"prop1": "string",
"prop2": 0,
"prop3": [
[
"value1",
"value2"
]
]
}