URL, усул, конвенсияҳои хатогӣ ('GET', 'POST', 'PUT', 'НЕСТ')

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