Play IT

Проектирование API

Интерактивное демо «Проектирование API» — раздел Энциклопедия · Инфраструктура и безопасность.

infra-securityencyclopedia

Проектирование REST API

Версионирование, именование ресурсов, RFC 7807 и идемпотентный POST.

https://api.example.com/v1/users

Понятно в логах и curl · Несколько URI на один ресурс

ИзбегатьПредпочтительно
GET /getUsersGET /users
POST /users/delete/5DELETE /users/5
GET /api/userGET /api/v1/users
{
  "type": "https://api.example.com/problems/validation-error",
  "title": "Нарушение валидации",
  "status": 400,
  "invalidParams": [
    {
      "name": "email",
      "reason": "неверный формат"
    }
  ]
}

Запрос ещё не отправлялся