200 OK
API v1

Eine Test-API für Entwicklung und Debugging.

Endpunkte

IP

/v1/ip

Ausgabe
GET

Die IPv4- und IPv6-Adressen des Clients.

Details
Beispielanfragen

GET

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

Die Adresse der Clientverbindung. Das Beispiel verwendet eine Dokumentations-IP. Eine unbekannte Adressfamilie wird im Text als unknown und in JSON als null ausgegeben.

Beispiel · text/plain

v4: 192.0.2.1
v6: unknown
400 Bad Request

Ungültiges format, zum Beispiel ?format=xml. Dieser Fehler wird immer als Klartext zurückgegeben.

Beispiel · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v4

Ausgabe
GET

Die IPv4-Adresse des Clients.

Details
Beispielanfragen

GET

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

Die Adresse der Clientverbindung. Das Beispiel verwendet eine Dokumentations-IP. Eine unbekannte Adressfamilie wird im Text als unknown und in JSON als null ausgegeben.

Beispiel · text/plain

192.0.2.1
400 Bad Request

Ungültiges format, zum Beispiel ?format=xml. Dieser Fehler wird immer als Klartext zurückgegeben.

Beispiel · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v6

Ausgabe
GET

Die IPv6-Adresse des Clients.

Details
Beispielanfragen

GET

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

Die Adresse der Clientverbindung. Das Beispiel verwendet eine Dokumentations-IP. Eine unbekannte Adressfamilie wird im Text als unknown und in JSON als null ausgegeben.

Beispiel · text/plain

2001:db8::1
400 Bad Request

Ungültiges format, zum Beispiel ?format=xml. Dieser Fehler wird immer als Klartext zurückgegeben.

Beispiel · text/plain

Unsupported format: xml
Valid values: text, json

Echo

/v1/echo

Ausgabe
GETPOSTPUTPATCHDELETE

Gibt die Methode und den Inhalt der Anfrage zurück. Akzeptiert JSON, Klartext, einfache Formulardaten und Binärdaten.

Details
Beispielanfragen

POST · JSON

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

POST · Klartext

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

POST · Formular

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

POST · Binärdatei

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

Die Methode und der geparste Anfrageinhalt. Dieses Beispiel zeigt eine GET-Anfrage ohne Inhalt.

Beispiel · text/plain

GET

null
400 Bad Request

Ungültiges format, zum Beispiel ?format=xml. Dieser Fehler wird immer als Klartext zurückgegeben.

Beispiel · text/plain

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

Der Anfrageinhalt überschreitet 102.400 Bytes (100 KiB).

Beispiel · text/plain

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

Nicht unterstützter oder fehlender Content-Type bei nicht leerem Anfrageinhalt.

Beispiel · text/plain

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

Ungültiges JSON führt ebenfalls zu 400. Bei Syntax- und Kodierungsfehlern des Parsers wird derzeit unabhängig vom Ausgabeformat die Standard-HTML-Antwort von Express verwendet.

Headers

/v1/headers

Ausgabe
GET

Header der eingehenden Anfrage.

Details
Beispielanfragen

Mit eigenem Header

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

Header der eingehenden Anfrage. Namen und Werte hängen vom Client ab.

Beispiel · text/plain

host:  localhost:3000

accept:  */*
400 Bad Request

Ungültiges format, zum Beispiel ?format=xml. Dieser Fehler wird immer als Klartext zurückgegeben.

Beispiel · text/plain

Unsupported format: xml
Valid values: text, json