mockapi.dog

Mock REST API juhend

Loo tasuta, kohesed REST API lõpp-punktid kohandatud vastuste, olekukoodide ja täiustatud funktsioonidega. Registreerimist ei nõuta.

Alustamine

Mock REST API lõpp-punkti loomine võtab vähem kui 30 sekundit. Järgi neid lihtsaid samme:

  1. 1

    Külasta avalehte

    Mine mockapi.dog ja vali "REST API" vahekaart.

  2. 2

    Vali HTTP meetod

    Vali GET, POST, PUT, PATCH või DELETE oma vajaduste põhjal.

  3. 3

    Kirjuta oma JSON-vastus

    Sisesta JSON-andmed, mida tahad lõpp-punkti tagastada. Redaktor valideerib JSON-i reaalajas.

    {
  "id": 1,
  "name": "John Doe",
  "email": "john@example.com"
}
  4. 4

    Seadista viivitused ja vigade simuleerimise seaded (valikuline)

    Lisa viivitusi, olekukoode, veamäärasid või kohandatud päiseid, kui vaja.

  5. 5

    Lõpeta kontroll ja salvesta

    Lõpeta Turnstile kontroll ja seejärel klõpsa "Salvesta mock-lõpp-punkt". Sinu lõpp-punkti URL kopeeritakse automaatselt!

    https://abc123.mockapi.dog/api/users

Sinu lõpp-punkt on koheselt aktiivne!

Pole juurutamist, pole ootamist. Hakka kohe päringuid tegema oma rakendusest, testidest või tööriistadest nagu Postman ja curl.

Põhifunktsioonid

HTTP meetodid

Kõigi standardsete HTTP meetodite tugi sinu API kujundusega sobitumiseks.

  • GET - Hangi andmeid
  • POST - Loo ressursse
  • PUT - Täielik uuendus
  • PATCH - Osaline uuendus
  • DELETE - Eemalda ressursse

Olekukoodid

Tagasta iga HTTP olekukood, et testida edu, vigu ja äärejuhtumeid.

  • 200OK - edu
  • 201Loodud
  • 400Vigane päring
  • 401Volitamata
  • 500Serveri viga

JSON-vastused

Tagasta iga kehtiv JSON-struktuur - lihtsatest objektidest keerukate pesastatud andmeteni.

  • Objektid ja massiivid
  • Pesastatud struktuurid
  • Objektide massiivid
  • Reaalajas valideerimine
  • Korrektne Content-Type

Täiustatud funktsioonid

Häälesta oma mock-lõpp-punkte võimsate funktsioonidega realistlike teststsenaariumide jaoks.

Vastuse viivitused

Simuleeri aeglasi võrke või serveri töötlemise aega, lisades vastustele viivitusi.

Kasutusjuhud:

  • Testi laadimisolekuid kasutajaliideses
  • Simuleeri aeglasi 3G/4G võrke
  • Veendu ajalõpu käsitlemises
  • Kontrolli skeleti-ekraane

Näiteviivitused:

500ms - kiire2000ms - normaalne5000ms - aeglane

Vigade simuleerimine

Sea protsent päringutest tagastama vigu. Ideaalne vigade käsitluse ja korduskatsete loogika testimiseks.

Kasutusjuhud:

  • Testi veapiire
  • Veendu korduskatsete mehhanismides
  • Kontrolli veateateid
  • Valideeri varuvariandi kasutajaliidest

Veamäära näited:

10% vigu50% vigu100% vigu

Tingimuslikud vead

Tagasta vigu konkreetsete tingimuste alusel nagu päise väärtused või päringumustrid.

Näidiskasutusjuhud:

  • Puuduv päis:Tagasta 401, kui X-API-Key päis pole olemas
  • Konkreetne ID:Tagasta 404 userId "999" jaoks, et testida ei-leitud stsenaariume
  • Päringu meetod:Tagasta 405 toetamata HTTP meetodite jaoks

TTL (eluiga)

Sea oma lõpp-punktidele aegumistähtaeg. Need kustutatakse automaatselt pärast määratud kestust.

Saadaval valikud:

1 tund24 tundi7 päeva30 päeva

Ideaalne ajutiste testide või demode jaoks. Pole vaja käsitsi puhastada.

Levinud ülesanded

Loo lõpp-punkt

  1. Klõpsa "Loo REST lõpp-punkt" nupul
  2. Vali HTTP meetod
  3. Sisesta oma JSON-vastus
  4. Seadista valikulised seaded
  5. Klõpsa "Loo lõpp-punkt"

✓ Sinu lõpp-punkt on nüüd aktiivne!

Muuda lõpp-punkti

  1. Leia oma lõpp-punkt "Minu lõpp-punktid" nimekirjast
  2. Klõpsa "Muuda" nupul
  3. Muuda vastust, olekut või seadeid
  4. Salvesta muudatused

✓ Muudatused on koheselt aktiivsed

Kustuta lõpp-punkt

  1. Leia lõpp-punkt, mida soovid eemaldada
  2. Klõpsa "Kustuta" nupul
  3. Kinnita kustutamine

Seda toimingut ei saa tagasi võtta

Testi lõpp-punkti

Kasutades curl'i:

curl https://abc123.mockapi.dog/api/users

Kasutades JavaScript'i:

fetch('https://abc123.mockapi.dog/api/users')

Veaotsing

Lõpp-punkt tagastab 404 ei leitud

Solution: Kontrolli lõpp-punkti URL-i veelkord. Veendu, et kasutad täpselt seda URL-i, mis pärast loomist anti, sealhulgas unikaalset ID-d.

Vigane JSON viga lõpp-punkti loomisel

Solution: Valideeri oma JSON sisseehitatud redaktoriga. Levinud probleemid: puuduvad komad, tsiteerimata võtmed, järelolevad komad või eskaapimata jutumärgid.

CORS vead brauseris

Solution: Kõik lõpp-punktid sisaldavad automaatselt CORS päiseid. Kui näed endiselt vigu, kontrolli, kas kasutad õiget URL-i ja HTTP meetodit.

Lõpp-punkt on liiga aeglane

Solution: Kontrolli, kas oled lisanud täpsemates seadetes vastuse viivituse. Eemalda või vähenda viivituse väärtust, kui pole vaja.

Nõuanded ja parimad praktikad

Kasuta realistlikke andmeid

Lisa realistlikke väljanimesid, andmetüüpe ja struktuure, mis vastavad su päris API-le. See muudab testimise väärtuslikumaks.

Testi äärejuhtumeid

Loo lõpp-punkte tühjade massiivide, null-väärtuste ja veastsenaariumide jaoks. See aitab vigu varakult kinni püüda.

Dokumenteeri oma lõpp-punkte

Pea oma lõpp-punktide ja nende eesmärkide nimekirja. Jaga URL-e meeskonnaliikmetega koostöö jaoks.

Kasuta viivitusi strateegiliselt

Lisa väikseid viivitusi laadimisolekute testimiseks. Kasuta pikemaid viivitusi ajalõpu käsitlemise verifitseerimiseks.

Versioneeri oma vastuseid

Loo mitu lõpp-punkti erinevate API versioonide jaoks. See aitab testida tagasiühilduvust.

Puhasta kasutamata lõpp-punktid

Kustuta regulaarselt lõpp-punkte, mida enam ei vaja. Kasuta TTL-i ajutiste lõpp-punktide automaatseks aegumiseks.

Kasutusvalmis mock API teek

Pakume eelnevalt ehitatud mock API-sid levinud kasutusjuhtude jaoks. Klõpsa mistahes kategoorial, et uurida kasutusvalmis lõpp-punkte, mida saad kohe testida - seadistust ei nõuta.

Users API

Kasutajaprofiilid, rollid, õigused ja kontode haldus

Posts API

Blogipostitused ja artiklid sisuhalduse mustritega

Todos API

Klassikaline CRUD näide oleku, filtreerimise ja lehekülgedeks jaotamisega

Auth API

Sisselogimine, väljalogimine, värskendustokenid ja kasutaja registreerimine

Products API

E-kaubanduse tooted hinna, saadavuse ja metaandmetega

Orders API

Tellimuste haldus olekuvoo ja kasutajaseostega

Cart API

Ostukorv toodete halduse ja seoste käsitlemisega

Payments API

Maksete töötlemine asünkroonsete operatsioonide ja webhook'idega

Profi nõuanne: sirvi täielikku teeki

Külasta meie mock API teeki et uurida kõiki eelnevalt ehitatud lõpp-punkte koos elavate näidete, näidisvastuste ja ühe klõpsuga testimisega.

Sõnastik

REST API

Representational State Transfer API - arhitektuuristiil veebiteenuste ehitamiseks standardseid HTTP meetodeid kasutades.

HTTP meetodid

Standardsed päringumeetodid (GET, POST, PUT, PATCH, DELETE), mis näitavad ressursi soovitud toimingut.

Olekukood

Kolmekohaline kood, mille server tagastab päringu tulemuse näitamiseks (200 OK, 404 ei leitud, 500 viga jne).

JSON

JavaScript Object Notation - kerge andmevorming kliendi ja serveri vahel andmete struktureerimiseks ja vahetamiseks.

Lõpp-punkt

Konkreetne URL, kust API-le pääseb juurde. Iga lõpp-punkt täidab konkreetset funktsiooni.

Mock API

Simuleeritud API, mis tagastab eelnevalt määratletud vastuseid; kasutatakse testimiseks ja arenduseks ilma päris backendita.

CORS

Cross-Origin Resource Sharing - turvafunktsioon, mis kontrollib, millised domeenid saavad sinu API-le brauseritest juurde pääseda.

TTL

Time To Live - kestus, mille jooksul lõpp-punkt eksisteerib enne automaatset kustutamist. Kasulik ajutiste testide jaoks.

Veamäär

Päringute protsent, mis peaks tagastama vigu. Kasutatakse vigade käsitluse ja korduskatsete loogika testimiseks.

Vastuse viivitus

Tehislik ooteaeg, mis lisatakse enne vastuse saatmist. Simuleerib aeglasi võrke või töötlemist.

Valmis oma esimese REST API loomiseks?

Alusta tasuta mock REST API lõpp-punktide ehitamist sekunditega. Registreerimist ei nõuta, krediitkaarti pole vaja. Ideaalne testimiseks, prototüüpimiseks ja arenduseks.

Loo REST lõpp-punkt nüüd →← Tagasi dokumentatsiooni