v1.0.0

Example of an OpenAPI document with security

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

This is an example of an OpenAPI document with security definitions and security requirements.

Servers

https://localhost:3000Local server

---

Default

Operations

GET/onlyApiKeyPOST/onlyBearerAuthPUT/apiKeyAndBearerAuthGET/apiKeyOrBearerAuth/{pathParam}GET/noSecurityPOST/multipleSecurity/{pathParam}

---

GET /onlyApiKey

GET

/onlyApiKey

Authorizations

apiKey

TypeAPI Key (header: api_key)

Example"your-api-key"

GET

/onlyApiKey

Playground

Authorization

apiKey

Samples

cURL

JavaScript

PHP

Python

---

POST /onlyBearerAuth

POST

/onlyBearerAuth

Authorizations

bearerAuth

TypeHTTP (bearer)

Example"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30"

POST

/onlyBearerAuth

Playground

Authorization

bearerAuth

Samples

cURL

JavaScript

PHP

Python

---

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

Required

Example"value"

PUT

/apiKeyAndBearerAuth

Playground

Authorization

apiKey

bearerAuth

Headers

headerParam*

Samples

cURL

JavaScript

PHP

Python

---

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

Required

GET

/apiKeyOrBearerAuth/{pathParam}

Playground

Authorization

apiKey

Variables

Key

Value

pathParam*

Samples

cURL

JavaScript

PHP

Python

---

GET /noSecurity

GET

/noSecurity

GET

/noSecurity

Playground

Samples

cURL

JavaScript

PHP

Python

---

POST /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

Required

Query Parameters

param1*

Query parameter description

Typestring

Required

Enum

"value1""value2"

default"value1"

param2*

Another query parameter description

Typestring

Required

Request Body

application/json

object

string[]

POST

/multipleSecurity/{pathParam}

Playground

Authorization

apiKey

bearerAuth

Variables

Key

Value

pathParam*

param1*

param2*

Body

Samples

cURL

JavaScript

PHP

Python