200 OK
API v1

Testowe API do programowania i debugowania.

Endpointy

IP

/v1/ip

Format odpowiedzi
GET

Adresy IPv4 i IPv6 klienta.

Szczegóły
Przykłady żądań

GET

curl 'http://localhost:3000/v1/ip'
Odpowiedzi
200 OK

Adres połączenia klienta. Przykład używa adresu IP przeznaczonego do dokumentacji. Nieznana rodzina adresów jest oznaczona jako unknown w tekście i null w JSON.

Przykład · text/plain

v4: 192.0.2.1
v6: unknown
400 Bad Request

Nieprawidłowy format, np. ?format=xml. Ten błąd jest zawsze zwracany jako zwykły tekst.

Przykład · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v4

Format odpowiedzi
GET

Adres IPv4 klienta.

Szczegóły
Przykłady żądań

GET

curl 'http://localhost:3000/v1/ip/v4'
Odpowiedzi
200 OK

Adres połączenia klienta. Przykład używa adresu IP przeznaczonego do dokumentacji. Nieznana rodzina adresów jest oznaczona jako unknown w tekście i null w JSON.

Przykład · text/plain

192.0.2.1
400 Bad Request

Nieprawidłowy format, np. ?format=xml. Ten błąd jest zawsze zwracany jako zwykły tekst.

Przykład · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v6

Format odpowiedzi
GET

Adres IPv6 klienta.

Szczegóły
Przykłady żądań

GET

curl 'http://localhost:3000/v1/ip/v6'
Odpowiedzi
200 OK

Adres połączenia klienta. Przykład używa adresu IP przeznaczonego do dokumentacji. Nieznana rodzina adresów jest oznaczona jako unknown w tekście i null w JSON.

Przykład · text/plain

2001:db8::1
400 Bad Request

Nieprawidłowy format, np. ?format=xml. Ten błąd jest zawsze zwracany jako zwykły tekst.

Przykład · text/plain

Unsupported format: xml
Valid values: text, json

Echo

/v1/echo

Format odpowiedzi
GETPOSTPUTPATCHDELETE

Zwraca metodę i treść żądania. Obsługuje JSON, zwykły tekst, proste dane formularza i dane binarne.

Szczegóły
Przykłady żądań

POST · JSON

curl 'http://localhost:3000/v1/echo' \
  -H 'Content-Type: application/json' \
  --data-binary '{"name":"Bob"}'

POST · Zwykły tekst

curl 'http://localhost:3000/v1/echo' \
  -H 'Content-Type: text/plain' \
  --data-binary 'Hello!'

POST · Formularz

curl 'http://localhost:3000/v1/echo' \
  --data-urlencode 'name=Bob' \
  --data-urlencode 'age=42'

POST · Plik binarny

curl 'http://localhost:3000/v1/echo' \
  -H 'Content-Type: application/octet-stream' \
  --data-binary '@./file.bin'
Odpowiedzi
200 OK

Metoda i przetworzona treść żądania. Ten przykład przedstawia żądanie GET bez treści.

Przykład · text/plain

GET

null
400 Bad Request

Nieprawidłowy format, np. ?format=xml. Ten błąd jest zawsze zwracany jako zwykły tekst.

Przykład · text/plain

Unsupported format: xml
Valid values: text, json
413 Payload Too Large

Treść przekracza 102 400 bajtów (100 KiB).

Przykład · text/plain

Request body exceeds the size limit of 100 KiB
415 Unsupported Media Type

Nieobsługiwany lub brakujący Content-Type dla niepustej treści.

Przykład · text/plain

Unsupported Content-Type. Supported: application/json, text/plain, application/x-www-form-urlencoded, application/octet-stream

Nieprawidłowy JSON również zwraca 400. Błędy składni i kodowania parsera obecnie zwracają domyślną odpowiedź HTML Express, niezależnie od wybranego formatu.

Headers

/v1/headers

Format odpowiedzi
GET

Nagłówki przychodzącego żądania.

Szczegóły
Przykłady żądań

Z własnym nagłówkiem

curl 'http://localhost:3000/v1/headers' \
  -H 'X-Test: hello'
Odpowiedzi
200 OK

Nagłówki przychodzącego żądania. Nazwy i wartości zależą od klienta.

Przykład · text/plain

host:  localhost:3000

accept:  */*
400 Bad Request

Nieprawidłowy format, np. ?format=xml. Ten błąd jest zawsze zwracany jako zwykły tekst.

Przykład · text/plain

Unsupported format: xml
Valid values: text, json