200 OK
API v1

Une API de test pour le développement et le débogage.

Points de terminaison

IP

/v1/ip

Format de sortie
GET

Les adresses IPv4 et IPv6 du client.

Détails
Exemples de requêtes

GET

curl 'http://localhost:3000/v1/ip'
Réponses
200 OK

L’adresse de connexion du client. Cet exemple utilise une IP réservée à la documentation. Une famille d’adresses inconnue est représentée par unknown en texte et null en JSON.

Exemple · text/plain

v4: 192.0.2.1
v6: unknown
400 Bad Request

Valeur de format invalide, par exemple ?format=xml. Cette erreur est toujours renvoyée en texte brut.

Exemple · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v4

Format de sortie
GET

L’adresse IPv4 du client.

Détails
Exemples de requêtes

GET

curl 'http://localhost:3000/v1/ip/v4'
Réponses
200 OK

L’adresse de connexion du client. Cet exemple utilise une IP réservée à la documentation. Une famille d’adresses inconnue est représentée par unknown en texte et null en JSON.

Exemple · text/plain

192.0.2.1
400 Bad Request

Valeur de format invalide, par exemple ?format=xml. Cette erreur est toujours renvoyée en texte brut.

Exemple · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v6

Format de sortie
GET

L’adresse IPv6 du client.

Détails
Exemples de requêtes

GET

curl 'http://localhost:3000/v1/ip/v6'
Réponses
200 OK

L’adresse de connexion du client. Cet exemple utilise une IP réservée à la documentation. Une famille d’adresses inconnue est représentée par unknown en texte et null en JSON.

Exemple · text/plain

2001:db8::1
400 Bad Request

Valeur de format invalide, par exemple ?format=xml. Cette erreur est toujours renvoyée en texte brut.

Exemple · text/plain

Unsupported format: xml
Valid values: text, json

Echo

/v1/echo

Format de sortie
GETPOSTPUTPATCHDELETE

Renvoie la méthode et le corps de la requête. Accepte JSON, le texte brut, les données de formulaire simples et les données binaires.

Détails
Exemples de requêtes

POST · JSON

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

POST · Texte brut

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

POST · Formulaire

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

POST · Fichier binaire

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

La méthode et le corps de la requête après analyse. Cet exemple est une requête GET sans corps.

Exemple · text/plain

GET

null
400 Bad Request

Valeur de format invalide, par exemple ?format=xml. Cette erreur est toujours renvoyée en texte brut.

Exemple · text/plain

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

Le corps dépasse 102 400 octets (100 Kio).

Exemple · text/plain

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

Content-Type non pris en charge ou absent pour un corps non vide.

Exemple · text/plain

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

Un JSON invalide renvoie également 400. Les erreurs de syntaxe et d’encodage du parseur utilisent actuellement la réponse HTML par défaut d’Express, quel que soit le format de sortie choisi.

Headers

/v1/headers

Format de sortie
GET

En-têtes de la requête entrante.

Détails
Exemples de requêtes

Avec un en-tête personnalisé

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

En-têtes de la requête entrante. Les noms et les valeurs dépendent du client.

Exemple · text/plain

host:  localhost:3000

accept:  */*
400 Bad Request

Valeur de format invalide, par exemple ?format=xml. Cette erreur est toujours renvoyée en texte brut.

Exemple · text/plain

Unsupported format: xml
Valid values: text, json