200 OK
API v1

Testirajapinta kehitykseen ja virheenjäljitykseen.

Päätepisteet

IP

/v1/ip

Vastausmuoto
GET

Asiakkaan IPv4- ja IPv6-osoitteet.

Lisätiedot
Esimerkkipyynnöt

GET

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

Asiakasyhteyden osoite. Esimerkissä käytetään dokumentaatioon varattua IP-osoitetta. Tuntematon osoiteperhe esitetään tekstissä arvona unknown ja JSONissa arvona null.

Esimerkki · text/plain

v4: 192.0.2.1
v6: unknown
400 Bad Request

Virheellinen format-arvo, esimerkiksi ?format=xml. Tämä virhe palautetaan aina pelkkänä tekstinä.

Esimerkki · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v4

Vastausmuoto
GET

Asiakkaan IPv4-osoite.

Lisätiedot
Esimerkkipyynnöt

GET

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

Asiakasyhteyden osoite. Esimerkissä käytetään dokumentaatioon varattua IP-osoitetta. Tuntematon osoiteperhe esitetään tekstissä arvona unknown ja JSONissa arvona null.

Esimerkki · text/plain

192.0.2.1
400 Bad Request

Virheellinen format-arvo, esimerkiksi ?format=xml. Tämä virhe palautetaan aina pelkkänä tekstinä.

Esimerkki · text/plain

Unsupported format: xml
Valid values: text, json

/v1/ip/v6

Vastausmuoto
GET

Asiakkaan IPv6-osoite.

Lisätiedot
Esimerkkipyynnöt

GET

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

Asiakasyhteyden osoite. Esimerkissä käytetään dokumentaatioon varattua IP-osoitetta. Tuntematon osoiteperhe esitetään tekstissä arvona unknown ja JSONissa arvona null.

Esimerkki · text/plain

2001:db8::1
400 Bad Request

Virheellinen format-arvo, esimerkiksi ?format=xml. Tämä virhe palautetaan aina pelkkänä tekstinä.

Esimerkki · text/plain

Unsupported format: xml
Valid values: text, json

Echo

/v1/echo

Vastausmuoto
GETPOSTPUTPATCHDELETE

Palauttaa pyynnön metodin ja sisällön. Hyväksyy JSONin, pelkän tekstin, yksinkertaiset lomaketiedot ja binääridatan.

Lisätiedot
Esimerkkipyynnöt

POST · JSON

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

POST · Pelkkä teksti

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

POST · Lomake

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

POST · Binääritiedosto

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

Pyynnön metodi ja jäsennetty sisältö. Tässä esimerkissä on GET-pyyntö ilman sisältöä.

Esimerkki · text/plain

GET

null
400 Bad Request

Virheellinen format-arvo, esimerkiksi ?format=xml. Tämä virhe palautetaan aina pelkkänä tekstinä.

Esimerkki · text/plain

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

Sisältö ylittää 102 400 tavua (100 KiB).

Esimerkki · text/plain

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

Content-Type puuttuu tai sitä ei tueta, vaikka pyynnössä on sisältöä.

Esimerkki · text/plain

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

Virheellinen JSON palauttaa myös koodin 400. Jäsentimen syntaksi- ja merkistökoodausvirheet käyttävät toistaiseksi Expressin oletusarvoista HTML-vastausta valitusta vastausmuodosta riippumatta.

Headers

/v1/headers

Vastausmuoto
GET

Saapuvan pyynnön otsakkeet.

Lisätiedot
Esimerkkipyynnöt

Omalla otsakkeella

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

Saapuvan pyynnön otsakkeet. Nimet ja arvot riippuvat asiakkaasta.

Esimerkki · text/plain

host:  localhost:3000

accept:  */*
400 Bad Request

Virheellinen format-arvo, esimerkiksi ?format=xml. Tämä virhe palautetaan aina pelkkänä tekstinä.

Esimerkki · text/plain

Unsupported format: xml
Valid values: text, json