URL, API usullary we ýalňyşlyklary

URL, usullar, ýalňyşlyklar konwensiýalary ('GET', 'POST', 'PUT', 'DELETE')

Soňky üýtgetme:
Stanislaw Anisimow
URL, usullar, ýalňyşlyklar konwensiýalary ('GET', 'POST', 'PUT', 'DELETE')
Click to expand / collapse

Ygtybarly we düşnükli API interfeýsleri gurmagyň anyk düzgünlerinden başlaýar. Her bir dörediji nämä garaşmalydygyny bilmek üçin iň oňat REST tejribesine eýerýäris: URL gurluşy mantykly, usullar herekete laýyk gelýär we ýalňyşlyklar aňsatlyk bilen düşündirilýär.

Bu giriş çägini peseldýär, integrasiýany ýönekeýleşdirýär we ulgamy bulam-bujarsyz giňeltmäge mümkinçilik berýär.

URL konwensiýalary we HTTP-usullar

UsulMaksadySoragyň mysaly
`GET`Resurs almak`GET /users/42`
`POST`Täze çeşme döretmek`POST /users`
`PUT`Resursyň doly täzelenmegi`PUT /users/42`
`PATCH`Çeşmäni bölekleýin täzelemek (ops.) `PATCH /users/42`
`DELETE`Çeşmäni aýyrmak`DELETE /users/42`

Atlar köplükde ulanylýar ('/users ', '/devices', '/games ')

Içindäki zatlar iýerarhiýa hökmünde beýan edilýär ('/users/42/sessions ')

Ähli soraglar HTTPS arkaly gidýär

Hatalary bejermegiň standartlary

KodBahasyHabar mysaly
`400`Nädogry haýyş`Missing required field: email`
`401`Ygtyýarnamasyz`Invalid token or expired session`
`403`Giriş gadagan`Access denied to resource`
`404`Tapylmady`User with ID 42 not found`
`409`Gapma-garşylyk (mysal üçin, köpeltmek)`Email already in use`
`422`Tassyklama hatasy`Field 'age' must be a number`
`500`Içerki serwer hatasy`Unexpected exception, contact support`
Hatanyň jogap gurluşy: 
json
{
"error": {
"code": 400,   "message": "Missing required field: email",   "details": {...}
}
}

Işläp düzüjiler üçin artykmaçlyklar

Goşmaça resminamalarsyz API logikasyna çalt düşünmek

Modullaryň we zatlaryň hemmesine birmeňzeş çemeleşmek

Adaty kodlaryň we formatlaryň kömegi bilen aňsat düzedişler we loglar

OpenAPI/Swagger, Postman, SDK awtogenerasiýasy bilen gabat gelmek

Goldawyň, synagyň we CI/CD-iň ýönekeýleşdirilmegi

Bu ýerde aýratyn möhümdir

Açyk ýa-da hyzmatdaş API platformalary

Birnäçe ösüş topary bolan taslamalar

Mikroservisleriň arhitekturasy ýa-da API-first çemeleşmesi

Köp sanly jandarlar we özara täsirleri bolan ulgamlar

Bitewi konwensiýalar API-ni ygtybarly, düşnükli we amatly edýär. Her integrasiýanyň çalt, düşünişmezliksiz we iň ýokary çaklama bilen geçmegi üçin iň oňat REST tejribesine eýerýäris.

Meşhur mowzuklar

Esasy mowzuklar