URL, методи та помилки API

Конвенції URL, методів, помилок ('GET','POST','PUT','DELETE')

Останнє редагування:
Станіслав Анісімов
Конвенції URL, методів, помилок ('GET','POST','PUT','DELETE')
Click to expand / collapse

Надійний і зрозумілий API починається з чітких правил побудови інтерфейсів. Ми дотримуємося кращих практик REST, щоб кожен розробник знав, чого очікувати: структура URL логічна, методи відповідають дії, а помилки легко інтерпретуються.

Це знижує поріг входу, спрощує інтеграції і дозволяє масштабувати систему без хаосу.

Конвенції URL і HTTP-методів

МетодПризначенняПриклад запиту
`GET`Отримання ресурсу`GET /users/42`
`POST`Створення нового ресурсу`POST /users`
`PUT`Повне оновлення ресурсу`PUT /users/42`
`PATCH`Часткове оновлення ресурсу (опц.) `PATCH /users/42`
`DELETE`Видалення ресурсу`DELETE /users/42`

Використовуються іменники в множині ('/users', '/devices', '/games')

Вкладені сутності описуються як ієрархія ('/users/42/sessions')

Всі запити йдуть через HTTPS

Стандарти обробки помилок

КодЗначенняПриклад повідомлення
`400`Неправильний запит`Missing required field: email`
`401`Неавторизований`Invalid token or expired session`
`403`Доступ заборонено`Access denied to resource`
`404`Не знайдено`User with ID 42 not found`
`409`Конфлікт (наприклад, дублювання)`Email already in use`
`422`Помилка валідації`Field 'age' must be a number`
`500`Внутрішня помилка сервера`Unexpected exception, contact support`
Структура відповіді на помилку: 
json
{
"error": {
"code": 400,   "message": "Missing required field: email",   "details": {...}
}
}

Переваги для розробників

Швидке розуміння логіки API без зайвої документації

Уніфікований підхід до всіх модулів і сутностей

Легке налагодження і логування завдяки стандартним кодам і форматам

Сумісність з OpenAPI/Swagger, Postman, автогенерацією SDK

Спрощення підтримки, тестування та CI/CD

Де особливо важливо

Платформи з відкритим або партнерським API

Проекти з декількома командами розробки

Архітектура мікросервісів або API-first підхід

Системи з великим числом сутностей і взаємодій

Єдині конвенції роблять API надійним, зрозумілим і зручним. Ми дотримуємося кращих REST-практик, щоб кожна інтеграція проходила швидко, без непорозумінь і з максимальною передбачуваністю.

Популярні теми

Основні теми