Что должно передаваться на вход и возвращаться в ответе для каждого из CRUD-методов?

Question

Для GET-запросов на вход передаются идентификатор или параметры фильтрации, возвращаются данные сущности или список. POST-запросы принимают данные для создания новой сущности и возвращают созданный объект с идентификатором. PUT/PATCH принимают идентификатор и данные для обновления, возвращают обновленную сущность. DELETE принимает идентификатор и возвращает статус операции без тела ответа или подтверждение удаления.

YeaHub · Accepted Answer

Стандартные подходы для CRUD-операцийCREATE (POST)Входные параметры:Тело запроса с данными для создания (обычно JSON объект)Заголовки для авторизации и типа контентаВозвращаемый ответ:HTTP статус 201 CreatedСозданная сущность с присвоенным идентификаторомЗаголовок Location с URL доступа к созданному ресурсуjson// Запрос POST /api/users
{
  "name": "John Doe",
  "email": "john@example.com"
}

// Ответ
{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "createdAt": "2023-10-01T10:00:00Z"
}READ (GET)Входные параметры:Идентификатор ресурса в URL путиПараметры запроса для фильтрации, пагинации (для списков)Возвращаемый ответ:HTTP статус 200 OKЗапрошенная сущность или список сущностейМетаданные для пагинации (для списков)json// Запрос GET /api/users/123
// Ответ
{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com"
}

// Запрос GET /api/users?page=1&limit=10
// Ответ
{
  "data": [
    {"id": 123, "name": "John Doe"},
    {"id": 124, "name": "Jane Smith"}
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 45
  }
}UPDATE (PUT/PATCH)Входные параметры:Идентификатор ресурса в URL путиТело запроса с полными (PUT) или частичными (PATCH) даннымиВозвращаемый ответ:HTTP статус 200 OKОбновленная сущностьjson// Запрос PATCH /api/users/123
{
  "name": "Johnathan Doe"
}

// Ответ
{
  "id": 123,
  "name": "Johnathan Doe",
  "email": "john@example.com"
}DELETE (DELETE)Входные параметры:Идентификатор ресурса в URL путиВозвращаемый ответ:HTTP статус 204 No Content (без тела)Или HTTP статус 200 OK с подтверждениемjson// Запрос DELETE /api/users/123
// Ответ: статус 204 No Content без телаРекомендации по проектированиюИспользуйте соответствующие HTTP статус-кодыОбеспечьте консистентность форматов запросов и ответовДокументируйте обязательные и опциональные поляИспользуйте DTO для отделения внутренней модели от APIВывод: Соблюдение стандартных подходов к проектированию CRUD-методов обеспечивает предсказуемость API, упрощает интеграцию и улучшает опыт разработчиков.