API боэътимод ва интуитивӣ аз қоидаҳои возеҳи сохтани интерфейсҳо оғоз меёбад. Мо таҷрибаҳои беҳтарини REST-ро риоя мекунем, то ҳар як таҳиякунанда чиро интизор шавад: сохтори URL мантиқӣ аст, усулҳо барои амал мувофиқанд ва хатогиҳо ба осонӣ шарҳ дода мешаванд.
Ин ҳадди вурудро паст мекунад, ҳамгироиро содда мекунад ва ба система имкон медиҳад, ки бидуни бетартибӣ миқёс гирад.
Конвенсияҳои усулҳои URL ва HTTP
| Усул | Таъинот | Пурсиши намунавӣ |
|---|---|---|
| 'ГЕТЖАПОС | Гирифтани манбаъ | 'GET/корбарон/42' |
| 'ПОСТЖАПОС | Сохтани захираи нав | 'POST/истифодабарандагон' |
| 'ПУТ.БАПОС | Навсозии пурраи захираҳо | 'PUT/корбарон/42' |
| 'ПАТЧЖАПОС | Навсозии қисман захираҳо (Опт) 'PATCH/корбарон/42' | |
| 'НЕСТ' АПОС | Нобуд кардани манбаъ | 'Нест кардани/корбарон/42' |
Исмҳои бисёрҷониба истифода мешаванд ('/корбарон ', '/дастгоҳҳо', '/бозиҳо ')
Субъектҳои лона ҳамчун зинанизом тавсиф карда мешаванд ('/корбарон/42/сессияҳо ')
Ҳама дархостҳо тавассути HTTPS мегузаранд
Стандартҳои коркарди хатогӣ
| Рамз | Арзиш | Иттилооти намунавӣ |
|---|---|---|
| `400` | дархости нодуруст | 'Майдони талабнашуда: почтаи электронӣ' |
| `401` | Иҷозат дода нашудааст | 'Аломати нодуруст ё мӯҳлати гузашта' |
| `403` | Дастрасӣ рад карда шуд | 'Дастрасӣ ба захираҳо рад карда шуд' |
| `404` | ёфт нашуд | 'Корбар бо ID 42 асос намеёбад' |
| `409` | Низоъ (мас. такрори) | 'Почтаи электронӣ аллакай дар истифода аст' |
| `422` | Хатои тасдиқот | 'Синну соли саҳроӣ' бояд рақам бошад ' |
| `500` | Хатои сервери дохилӣ | 'Истисно ғайричашмдошт, дастгирии тамос' |
json
{
"error": {
"code": 400, "message": "Missing required field: email", "details": {...}
}
}Манфиатҳои таҳиякунанда
Фаҳмиши фаврии мантиқи API бидуни ҳуҷҷатҳои нолозим
Муносибати ягона ба ҳамаи модулҳо ва объектҳо
Ислоҳи осон ва сабти ном ба туфайли рамзҳо ва форматҳои стандартӣ
Мутобиқат бо Open-API/Swagger, Postman, автогенератсияи SDK
Дастгирӣ, озмоиш ва CI/CD-ро содда мекунад
Дар куҷо махсусан муҳим
Платформаҳои API кушода ё шарик
Лоиҳаҳо бо гурӯҳҳои сершумори рушд
Меъмории Microservices ё равиши аввалини API
Системаҳо бо бисёр объектҳо ва робитаҳои муштарак
Конвенсияҳои ягона API-ро боэътимод, фаҳмо ва қулай мегардонанд. Мо таҷрибаҳои беҳтарини REST-ро риоя мекунем, то ҳар як ҳамгироӣ зуд, бидуни нофаҳмиҳо ва пешгӯии ҳадди аксар сурат гирад.