Документация API для Candidates API

Добро пожаловать в документацию API сервиса Candidates API! Этот API предоставляет простой и удобный способ управления кандидатами на вакансии. Документация предназначена для разработчиков и тестировщиков, начинающих работу с API, и содержит всю необходимую информацию для интеграции и использования.

Обзор

Название API: Candidates API
Версия: 1.0.0
Базовый URL: https://v0-test-api-ten.vercel.app/
Формат данных: JSON
Аутентификация: Требуется API-ключ

API предоставляет CRUD-доступ к записям пользователей по эндпоинтам /v1/api/users. Все запросы отправляются через HTTPS.

Быстрый старт

Требования

Postman или любой другой инструмент для HTTP-запросов
Скачать Postman

Пример запроса (Postman)

Установите https://v0-test-api-ten.vercel.app/ как базовый URL
Добавьте заголовок X-Fix-Bug: ВАШ_API_КЛЮЧ
Отправьте любой из запросов ниже

Эндпоинты API

1. Получение списка пользователей

Метод: GET
URL: /v1/api/users
Описание: Возвращает список всех пользователей. Можно передать необязательный query-параметр status: minor, candidate, retired.
Query-параметр status не чувствителен к регистру.
Пример запроса:
```
GET /v1/api/users?status=candidate
```

Пример ответа:

[
  {
    "id": 1,
    "name": "John Doe",
    "age": 25,
    "status": "candidate"
  }
]

2. Получение пользователя по ID

Метод: GET
URL: /v1/api/users/{id}
Описание: Возвращает одного пользователя по ID.
Пример запроса:
```
GET /v1/api/users/1
```

Пример ответа:

{
  "id": 1,
  "name": "John Doe",
  "age": 25,
  "status": "candidate"
}

3. Создание нового пользователя

Метод: POST
URL: /v1/api/users
Описание: Создает нового пользователя. Обязательные поля:
- name: строка, только латиница, пробелы, тире
- age: число, ≥ 0
Пример запроса:
```
{
  "name": "Jane Smith",
  "age": 30
}
```

Пример ответа:

{
  "id": 2,
  "name": "Jane Smith",
  "age": 30,
  "status": "candidate"
}

4. Обновление пользователя

Метод: PATCH
URL: /v1/api/users/{id}
Описание: Обновляет данные пользователя. Требования к полям:
- name: строка, латиница, пробелы, тире
- age: число, ≥ 0

Пример запроса:

{
  "name": "Updated Name",
  "age": 66
}

Пример ответа:

{
  "id": 2,
  "name": "Updated Name",
  "age": 66,
  "status": "retired"
}

5. Удаление пользователя

Метод: DELETE
URL: /v1/api/users/{id}
Описание: Удаляет пользователя по ID.
Пример запроса:
```
DELETE /v1/api/users/2
```

Пример ответа:

{
  "message": "User deleted successfully",
  "user": {
    "id": 2,
    "name": "Updated Name",
    "age": 66,
    "status": "retired"
  }
}

Формат данных

Пользователь (User):

{
  "id": number,
  "name": "string",
  "age": number,
  "status": "minor" | "candidate" | "retired"
}

Ошибки:

{
  "message": "string"
}

Требования к запросам

Формат: JSON
Заголовок X-Fix-Bug обязателен
Метод PATCH и POST требуют Content-Type: application/json

Примечания для разработчиков

API доступен 24/7
Рекомендуется использовать Postman для отладки

Документация API для Candidates API

Оглавление

Требования

Пример запроса (Postman)