Lähetä HTTP-pyyntö

Ensimmäisen pyynnön lähettäminen kestää noin kymmenen sekuntia. Tämä opas käy läpi perusteet ja kattaa kaiken, mitä tarvitset päivittäiseen API-testaukseen.

Ensimmäinen pyyntösi

1. Avaa HTTP-paneeli — paina Cmd+H (Mac) tai Ctrl+H (Windows/Linux) tai klikkaa HTTP-kuvaketta vasemman reunan rivistä.
2. Kirjoita tai liitä URL osoitepalkkiin yläosaan. Esimerkiksi: https://jsonplaceholder.typicode.com/posts/1
3. Valitse metodi — metodin alasvetovalikko näyttää oletuksena GET:n. Klikkaa vaihtaaksesi POST:iin, PUT:iin, DELETE:hen, PATCH:iin, HEAD:iin tai OPTIONS:iin.
4. Klikkaa Send — sininen Send-painike laukaisee pyynnön.
5. Lue vastaus — vastauksen paneeli ilmestyy alle tilakoodi, otsikot ja runko mukanaan.

Siinä kaikki. Ei projektin alustusta, ei konfiguraatiotiedostoja, ei tilejä tarvita.

Lisää pyyntöotsikot

Useimmat API:t vaativat otsikoita — todennukseen, sisältötyyppiin tai versiointiin. Lisätäksesi niitä:

1. Klikkaa Headers-välilehteä (Paramsin ja Bodyn vieressä)
2. Klikkaa + Add Header
3. Kirjoita otsikon nimi vasempaan kenttään ja arvo oikeaan kenttään
4. Otsikot lähetetään automaattisesti jokaisen pyynnön mukana kunnes poistat ne

Tässä yleisimmät otsikot, joita käytät:

Voit lisätä niin monta otsikkoa kuin tarvitset. Poista otsikon vieressä oleva valintaruutu väliaikaisesti poistaaksesi sen käytöstä ilman sen poistamista.

Lisää pyynnön runko

POST-, PUT- ja PATCH-pyynnöille lähetät yleensä rungon datan kanssa. Näin se tehdään:

1. Klikkaa Body-välilehteä
2. Valitse JSON muodon alasvetovalikosta (tai Form, Text tai Binary API:stasi riippuen)
3. Kirjoita tai liitä JSON-hyötykuormasi

Esimerkkejä JSON-rungosta uuden julkaisun luomiseksi:

{
  "title": "My New Post",
  "body": "This is the content of the post.",
  "userId": 1
}

Editori tarkistaa JSON:isi kirjoittaessasi ja alleviivaa syntaksivirheet. Korjaa ne ennen lähettämistä — virheellinen runko aiheuttaa yleensä 400 Bad Request -virheen.

Tarkasta vastaus

Pyynnön valmistuttua vastauksen paneeli näyttää kaiken tarvitsemasi:

• Tilakoodi — näkyy korostetusti yläosassa. Vihreä 2xx-onnistumisille, keltainen 3xx-uudelleenohjauksille, punainen 4xx-asiakavirheille ja 5xx-palvelinvirheille.
• Vastaamisaika — kuinka kauan pyyntö kesti, millisekunteina. Hyödyllinen hitaiden päätepisteiden havaitsemiseen.
• Vastauksen koko — vastauksen rungon koko.
• Runko — tulostetaan automaattisesti siististi, jos vastaus on JSON. Käytä puunäkymää tiivistämään ja laajentamaan sisäkkäisiä objekteja.
• Otsikot — klikkaa vastauksen paneelin Headers-välilehteä nähdäksesi jokaisen palvelimen lähettämän otsikon.

200 OK kelvollisella JSON:lla tarkoittaa, että päätepistesi toimii. 401 Unauthorized tarkoittaa yleensä, että todennusotsikkosi on väärä. 404 Not Found tarkoittaa, että URL-polku on väärä.

Tallenna pyyntö

Kun pyyntö toimii, tallenna se, ettet joudu kirjoittamaan URL:ia ja otsikoita uudelleen:

1. Klikkaa Save-painiketta (levyketiedostokuvake tai paina Cmd+S)
2. Anna pyynnölle kuvaava nimi — jotain kuten "Get user by ID" tai "Create product"
3. Valitse tai luo kokoelma, johon tallennat sen
4. Klikkaa Save

Tallennettu pyyntö näkyy vasemman reunan sivupalkissa kokoelmansa alla. Klikkaa sitä milloin tahansa ladataksesi URL:n, metodin, otsikot ja rungon täsmälleen sellaisena kuin tallensit ne. Kokoelmat säilyvät Sessionien välillä, joten pyyntösi ovat aina saatavilla, kun palaat takaisin.