v1.0.0
Example of an OpenAPI document with security
This is an example of an OpenAPI document with security definitions and security requirements.
Servers
https://localhost:3000Local server
ID: apiKeyOrBearerAuth
GET /apiKeyOrBearerAuth/{pathParam}
ID: multipleSecurity
POST /multipleSecurity/{pathParam}
POST
/multipleSecurity/{pathParam}
Authorizations
apiKey|bearerAuth +
apiKey
TypeAPI Key (header: api_key)
bearerAuth
TypeHTTP (bearer)
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-keyParameters
Path Parameters
pathParam*
Path parameter description
Typestring
RequiredQuery Parameters
param1*
Query parameter description
Typestring
RequiredEnum
value1value2default
value1param2*
Another query parameter description
Typestring
RequiredRequest Body
JSON
{
"prop1": "string",
"prop2": 0,
"prop3": [
[
"value1",
"value2"
]
]
}
POST
/multipleSecurity/{pathParam}