URL կոնվենցիաները, մեթոդները, սխալները («GET», «POST», «PUT», «MSETE»)
Սա նվազեցնում է մուտքի շեմն, պարզեցնում է պարամետրերը և թույլ է տալիս մեծացնել համակարգը առանց քաոսի։
URL և HTTP մեթոդներ
Այս մեթոդը ցույց է տալիս, որ նշանակման Օրինակ է հարցման մեջ
| -------- | ----------------------------------- | ------------------ | |
|---|---|---|---|
| 07 'GET' www.GET/users/42 '2019 ռեսուրսի ստացումը | |||
| 07 'POST "- մեջբերում է նոր ռեսուրսի ստեղծումը" POST/users "։ | |||
| ww.'PUT 'www.PUT/users/42' www.ru ռեսուրսի ամբողջական նորարարություն։ | |||
| www.'PATCH 'www.ru ռեսուրսի մասնակի նորարարություն (opc.) | `PATCH /users/42` | ||
| 07 'MSETE' www.MSETE/users/42 '2019 ռեսուրսի հեռացումը։ |
Օգտագործվում են բազմաթիվ թվերում («/users », «/devance», «/games »)
Ներդրված էությունը բացատրվում է որպես հիերարխիա («/users/42/sessions »)
Բոլոր հարցումները գնում են HTTPS միջոցով
Սխալների մշակման ստանդարտները
07 Ծածկագիրն է ՝ «Խոսքի օրինակ»։
| ----- | --------------------------------- | --------------------------------------- | |
|---|---|---|---|
| 07 '400' 112 "Missing required field: email '2019 | |||
| Neavtoriment Neavtoridan nevalid token or expired session '2019 | |||
| 07 '403' www.denied to resource | |||
| 07 '404' 108 «User with ID 42 www.t found» -ը չի հայտնաբերվել։ | |||
| www.'409 'www.Email already in use' of (օրինակ կրկնօրինակումը) wwww.et 'Email already in us | |||
| 07 '422' 112 «Field 'age' must be a numment» | |||
| 07 '500' 07 սերվերի ներքին սխալը «Unexpected eption, www.act super.ru» |
Պատասխանը սխալ է
```json
{
“ error “ : {
“ code “ : 400,
“ message “ : “ Missing required field: email “ ,
“ details “ : {...}
}
}
```
Զարգացողների առավելությունները
Արագ հասկանալ API տրամաբանությունը առանց լրացուցիչ փաստաթղթերի
Միավորված մոտեցում բոլոր մոդուլների և էակների նկատմամբ
Թեթև կարգաբերումը և տրամաբանությունը շնորհիվ ստանդարտ կոդերի և ձևերի
Համատեղելիությունը OpenAPI/Swagger, Postman, MSK ավտոմեքենաների հետ
Աջակցության, թեստավորման և CI/CD
Որտեղ հատկապես կարևոր է
Հարթակներ բաց կամ ավստրիական API
Նախագծեր մի քանի զարգացման թիմերի հետ
Միկրովարկների ճարտարապետությունը կամ API-first մոտեցումը
Համակարգերը մեծ թվով էակների և փոխազդեցությունների հետ
Միասնական կոնվենցիաները API-ն դարձնում են հուսալի, հասկանալի և հարմար։ Մենք պահպանում ենք լավագույն REST-պրակտիկան, որպեսզի յուրաքանչյուր ինտեգրումը արագ անցնի, առանց թյուրիմացությունների և կանխատեսելիության։
Կապ հաստատել մեզ հետ
Լրացրեք ստորև ներկայացված ձևը, և մենք հնարավորինս արագ կպատասխանենք ձեզ։