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

---

Default

Operations

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

---

ID: onlyApiKey

GET /onlyApiKey

Default

GET

/onlyApiKey

Authorizations

apiKey

TypeAPI Key (header: api_key)

GET

/onlyApiKey

Samples

cURL

curl https://localhost:3000/onlyApiKey \
  --header 'Apikey: apiKey' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://localhost:3000/onlyApiKey', {
  headers: {
    Apikey: 'apiKey',
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "https://localhost:3000/onlyApiKey",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Apikey: apiKey",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://localhost:3000/onlyApiKey"

headers = {
    "Apikey": "apiKey",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())

---

ID: onlyBearerAuth

POST /onlyBearerAuth

Default

POST

/onlyBearerAuth

Authorizations

bearerAuth

TypeHTTP (bearer)

POST

/onlyBearerAuth

Samples

cURL

curl https://localhost:3000/onlyBearerAuth \
  --request POST \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://localhost:3000/onlyBearerAuth', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "https://localhost:3000/onlyBearerAuth",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://localhost:3000/onlyBearerAuth"

headers = {
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)

print(response.json())

---

ID: apiKeyAndBearerAuth

PUT /apiKeyAndBearerAuth

Default

PUT

/apiKeyAndBearerAuth

Authorizations

apiKey

TypeAPI Key (header: api_key)

+

bearerAuth

TypeHTTP (bearer)

Parameters

Header Parameters

headerParam*

Header parameter description

Typestring

Required

Examplevalue

PUT

/apiKeyAndBearerAuth

Samples

cURL

curl https://localhost:3000/apiKeyAndBearerAuth \
  --request PUT \
  --header 'Apikey: apiKey' \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json' \
  --header 'Headerparam: value'

JavaScript

fetch('https://localhost:3000/apiKeyAndBearerAuth', {
  method: 'PUT',
  headers: {
    Apikey: 'apiKey',
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json',
    Headerparam: 'value'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "https://localhost:3000/apiKeyAndBearerAuth",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Apikey: apiKey",
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json",
    "Headerparam: value"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://localhost:3000/apiKeyAndBearerAuth"

headers = {
    "Apikey": "apiKey",
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json",
    "Headerparam": "value"
}

response = requests.put(url, headers=headers)

print(response.json())

---

ID: apiKeyOrBearerAuth

GET /apiKeyOrBearerAuth/{pathParam}

Default

GET

/apiKeyOrBearerAuth/{pathParam}

Authorizations

apiKey

TypeAPI Key (header: api_key)

or

bearerAuth

TypeHTTP (bearer)

Parameters

Path Parameters

pathParam*

Path parameter description

Typestring

Required

GET

/apiKeyOrBearerAuth/{pathParam}

Samples

cURL

curl 'https://localhost:3000/apiKeyOrBearerAuth/%7BpathParam%7D' \
  --header 'Apikey: apiKey' \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://localhost:3000/apiKeyOrBearerAuth/%7BpathParam%7D', {
  headers: {
    Apikey: 'apiKey',
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "https://localhost:3000/apiKeyOrBearerAuth/%7BpathParam%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Apikey: apiKey",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://localhost:3000/apiKeyOrBearerAuth/%7BpathParam%7D"

headers = {
    "Apikey": "apiKey",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())

---

ID: noSecurity

GET /noSecurity

Default

GET

/noSecurity

GET

/noSecurity

Samples

cURL

curl https://localhost:3000/noSecurity \
  --header 'Content-Type: application/json'

JavaScript

fetch('https://localhost:3000/noSecurity', {
  headers: {
    'Content-Type': 'application/json'
  }
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "https://localhost:3000/noSecurity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://localhost:3000/noSecurity"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())

---

ID: multipleSecurity

POST /multipleSecurity/{pathParam}

Default

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)

Examplespecial-key

Parameters

Path Parameters

pathParam*

Path parameter description

Typestring

Required

Query Parameters

param1*

Query parameter description

Typestring

Required

Enum

value1value2

defaultvalue1

param2*

Another query parameter description

Typestring

Required

Request Body

{

"prop1": "string",

"prop2": 0,

"prop3": [

[

"value1",

"value2"

]

]

}

POST

/multipleSecurity/{pathParam}

Samples

cURL

curl 'https://localhost:3000/multipleSecurity/%7BpathParam%7D' \
  --request POST \
  --header 'Apikey: apiKey' \
  --header 'Authorization: Bearer bearerAuth' \
  --header 'Content-Type: application/json' \
  --data '{
  "prop1": "string",
  "prop2": 0,
  "prop3": [
    [
      "value1",
      "value2"
    ]
  ]
}'

JavaScript

fetch('https://localhost:3000/multipleSecurity/%7BpathParam%7D', {
  method: 'POST',
  headers: {
    Apikey: 'apiKey',
    Authorization: 'Bearer bearerAuth',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prop1: 'string',
    prop2: 0,
    prop3: [{
      0: 'value1',
      1: 'value2'
    }]
  })
})

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "https://localhost:3000/multipleSecurity/%7BpathParam%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prop1' => 'string',
    'prop2' => 0,
    'prop3' => [
        [
                'value1',
                'value2'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Apikey: apiKey",
    "Authorization: Bearer bearerAuth",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://localhost:3000/multipleSecurity/%7BpathParam%7D"

payload = {
    "prop1": "string",
    "prop2": 0,
    "prop3": [["value1", "value2"]]
}
headers = {
    "Apikey": "apiKey",
    "Authorization": "Bearer bearerAuth",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

---

Powered by VitePress OpenAPI