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

    Määra tee ja HTTP meetod

    Sisesta ressursi tee genereeritud URL-i järele (näiteks /api/users) ja vali GET, POST, PUT, PATCH või DELETE.

  3. 3

    Kirjuta oma JSON-vastus

    Vali olekukood ja sisesta JSON, mida lõpp-punkt peab tagastama. Redaktor valideerib JSON-i kirjutamise ajal.

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

    Seadista viivitused ja vigade simuleerimise seaded (valikuline)

    Lisa vastuse viivitus, juhuslik veamäär või päringu päisega käivituv viga.

  5. 5

    Salvesta lõpp-punkt

    Klõpsa „Salvesta mock-lõpp-punkt“. Robotikontroll töötab taustal ja märkeruut ilmub ainult siis, kui seda on vaja märkida. 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

Lisa enne vastuse saatmist fikseeritud viivitus kuni 10000ms, et simuleerida aeglaseid võrke või serveri töötlemise aega.

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

Veavastuse keha:

{
  "error": "Simulated error (10% error rate)",
  "triggeredBy": "random-error-rate"
}

Tingimuslikud vead

Tagasta viga ainult siis, kui päringus on päis täpselt sinu määratud väärtusega. Saada päis, kui soovid viga, ja jäta see muul juhul ära.

Näidiskasutusjuhud:

  • Autentimisviga:X-Test-Auth: expired tagastab 401 sisselogimise ümbersuunamise testimiseks
  • Ei leitud:X-Test-Error: missing tagastab 404 tühjade olekute testimiseks
  • Katkestus:X-Test-Error: down tagastab 503 varuvariandi kasutajaliidese testimiseks

Kui päring vastab päisele, tagastatakse juhusliku veamäära asemel päise viga.

Veavastuse keha:

{
  "error": "Conditional error triggered by header X-Test-Error: down",
  "triggeredBy": "conditional-header-match"
}

TTL (eluiga)

Lõpp-punktid kuuluvad koodile, mis on sinu URL-i 6-tähemärgiline alamdomeen. Kui kood aegub, kustutatakse see koos kõigi selle lõpp-punktidega. Uued koodid aeguvad 1 kuu pärast. Pärast lõpp-punkti salvestamist saad seda muuta URL-i kõrval oleva kellanupuga.

Saadaval valikud:

1 nädal1 kuu (vaikimisi)3 kuudKohandatud (1-365 päeva)

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

Request Inspector

Jälgi oma lõpp-punktidesse saabuvaid päringuid reaalajas. Lülita salvestatud lõpp-punktide all olevas paneelis "Request Inspector" sisse lüliti "Logging".

  • Koodi viimased 50 päringut, uusimad eespool
  • Meetod, tee, olekukood ja vastuseaeg
  • Päised, päringuparameetrid ja päringu keha (üle 10KB kehad kärbitakse)
  • Authorization- ja küpsisepäised kuvatakse kujul [redacted]

Logimine on vaikimisi välja lülitatud ja hõlmab kõiki koodi lõpp-punkte. Jäädvustatakse ainult päringud, mis vastavad salvestatud lõpp-punktile, ja neid hoitakse 7 päeva pärast viimast päringut. Reaalajas vaate saad igal ajal peatada või nimekirja tühjendada.

Import ja eksport

Muuda olemasolev API kirjeldus ühe sammuga mockideks või laadi oma mockid alla, et neid jagada või koodi kõrval hoida. Impordi- ja ekspordinupud asuvad nupu „Salvesta mock-lõpp-punkt“ all.

Impordi OpenAPI-st või Postmanist

Kleebi või laadi fail üles, vaata selles olevaid lõpp-punkte eelvaates, eemalda märge neilt, mida ei soovi, ja impordi ülejäänud korraga praegusesse koodi.

Toetatud vormingud:

OpenAPI 3.x (JSON või YAML)Swagger 2.0 (JSON või YAML)Postmani kogum v2.0 / v2.1

Kuidas failist saavad mockid:

  • Igast operatsioonist saab üks sama meetodi ja teega lõpp-punkt.
  • Vastuseks võetakse 200 vastus, selle puudumisel 201, siis mõni muu 2xx. Kasutatakse selle näidet või genereeritakse see skeemist.
  • Mockid vastavad täpsetele teedele, seega saavad teeparameetrid näidisväärtuse: /users/{id} muutub /users/42-ks või /users/1-ks, kui failis näidet pole.
  • Baastee, näiteks /v1, jäetakse ära. Suuna selle asemel oma kliendi baas-URL mock-URL-ile.
  • Postmani päringud kasutavad esimest salvestatud 2xx näidisvastust ja tagastavad {}, kui seda pole.
  • HEAD-, OPTIONS- ja TRACE-operatsioonid jäetakse vahele.

Kuni 100 lõpp-punkti ja 2 MB faili kohta. Lõpp-punkt, mille meetod ja tee on juba olemas, jäetakse vahele, kui sa ei lülita sisse valikut „Asenda olemasolevad sama meetodi ja teega mockid“.

Ekspordi OpenAPI-sse või Postmani

Kui koodil on salvestatud lõpp-punkte, laadib „Ekspordi“ need kõik alla failina, mis osutab sinu mock-URL-ile.

  • OpenAPI 3: iga lõpp-punkt koos näidisvastusega. Viivitused, veasimulatsioon ja LLM-seaded salvestatakse x-mockapi-dog laiendisse, nii et faili uuesti importimine taastab need.
  • Postmani kogum v2.1: iga lõpp-punkti kohta üks päring, mille vastus on salvestatud näitena, ja {{baseUrl}} muutuja, mille väärtus on sinu mock-URL. Lõpp-punktide seadeid ei kaasata.

Seaded eksporditud OpenAPI failis:

"/users/1": {
  "get": {
    "responses": { "200": { ... } },
    "x-mockapi-dog": {
      "delayMs": 500,
      "errorRate": 10,
      "errorStatusCode": 503
    }
  }
}

Ekspordi käsurealt:

curl -o mocks.json \
  "https://api.mockapi.dog/api/mocks/export?code=abc123&format=openapi"

Postmani kogumi saamiseks kasuta format=postman.

Levinud ülesanded

Loo lõpp-punkt

  1. Ava mockapi.dog vahekaardil "REST API (JSON)"
  2. Lisa URL-ile tee ja vali HTTP meetod
  3. Sisesta oma JSON-vastus
  4. Seadista valikulised seaded
  5. Klõpsa „Salvesta mock-lõpp-punkt“ (märgi kontrolli ruut, kui see ilmub)

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

Muuda lõpp-punkti

  1. Leia oma lõpp-punkt "Salvestatud lõpp-punktid" nimekirjast
  2. Klõpsa pliiatsinupul ("Muuda")
  3. Muuda meetodit, vastust, olekut või seadeid (URL on muutmise ajal lukus)
  4. Klõpsa "Uuenda lõpp-punkti"

✓ Muudatused on koheselt aktiivsed

Kustuta lõpp-punkt

  1. Leia lõpp-punkt, mida soovid eemaldada
  2. Klõpsa prügikastinupul ("Kustuta")
  3. Lõpp-punkt eemaldatakse kohe, ilma kinnitust küsimata

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 URL-i, HTTP meetodit ja teed: kõik kolm peavad vastama salvestatule. Teed peavad täpselt kattuma, seega on /users/1 ja /users/2 eraldi lõpp-punktid. Kui need kattuvad, võib kood olla aegunud ja koos lõpp-punktidega kustutatud.

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.

Päringud tagastavad 429 liiga palju päringuid

Solution: Igal lõpp-punktil on päevane päringulimiit. Kui see täitub, tagastavad päringud 429 ning keha sisaldab limiiti ja resetAt aega (kesköö serveri aja järgi). Lisaks on iga IP-aadress kogu teenuses piiratud 100 päringuga minutis.

Request Inspector ei näita päringuid

Solution: Logimine on vaikimisi välja lülitatud. Lülita paneelis "Request Inspector" sisse lüliti "Logging" ja tee lõpp-punktile uuesti päring. Päringuid teedele, millel pole salvestatud lõpp-punkti, ei jäädvustata.

Import ei võta mu faili vastu

Solution: Import loeb OpenAPI 3.x, Swagger 2.0 ja Postman v2 kogumeid JSON- või YAML-vormingus. Üle 2 MB või enam kui 100 lõpp-punktiga failid lükatakse tagasi, seega jaga need enne osadeks. Viiteid teistele failidele ei järgita, seega koonda spetsifikatsioon ühte faili.

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.

Hoia mocke koodi juures

Ekspordi oma lõpp-punktid OpenAPI või Postmani kogumina ja lisa fail repositooriumi. Impordi see uude koodi alati, kui vajad samu mocke uuesti.

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 kood ja kõik selle lõpp-punktid eksisteerivad enne automaatset kustutamist.

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.

Kood

Sinu mock API unikaalne 6-tähemärgiline alamdomeen (abc123 aadressis abc123.mockapi.dog). Lõpp-punktid, aegumine ja päringute logimine kuuluvad kõik koodile.

Request Inspector

Reaalajas logi päringutest, mida koodi lõpp-punktid saavad, koos päiste, päringuparameetrite ja kehaga.

OpenAPI

Standardvorming REST API-de kirjeldamiseks, varem nimega Swagger. MockAPI Dog oskab luua mocke OpenAPI failist ja eksportida mocke selles vormingus.

Postmani kogum

Postmanis salvestatud API päringute fail, sageli koos näidisvastustega. MockAPI Dog oskab kogumeid importida ja eksportida.

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