База технических писателей

Версия API: 1.0.0

Описание API:

API для работы с базой данных о технических писателях и их навыками.

API позволяет получать:

список технических писателей,
список навыков каждого из них,
информацию о конкретном техническом писателе по идентификатору.

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

В версии API 1.0.0 реализовано добавление нового навыка, редактирование навыка, удаление навыка.

Список серверов:

Dev-сервер: https://dev.tw_api.com/v1

Prod-сервер: https://tw_api.com/v1

Список конечных точек

GET /techwriters

Получение списка технических писателей

Метод возвращает список технических писателей из базы.

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	limit	`integer`	query	Нет	Количество технических писателей в выдаче (для пагинации). Значение по умолчанию `20`

POST /techwriters

Добавление технического писателя в базу

Метод добавляет нового технического писателя в базу

GET /techwriters/{techwriterId}

Получение информации о техническом писателе по идентификатору

Метод возвращает информацию о техническом писателе по его идентификатору

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	techwriterId	`integer`	path	Да	Идентификатор технического писателя, о котором нужно получить информацию

PATCH /techwriters/{techwriterId}

Редактирование сведений о техническом писателе

Метод изменяет сведения о техническом писателе. Метод изменяет сведения частично: можно передать только имя, фамилию, отчество, опыт, номер телефона, адрес электронной почты или идентификатор навыка. Обязательно должен быть передан хотя бы один параметр

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	techwriterId	`integer`	path	Да	Идентификатор технического писателя, сведения о которым нужно изменить

DELETE /techwriters/{techwriterId}

Удаление технического писателя из базы

Метод для удаления технического писателя из базы по его идентификатору

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	techwriterId	`integer`	path	Да	Идентификатор технического писателя, которого нужно удалить из базы

GET /techwriters/{techwriterId}/skills/{skillId}

Получение информации о конкретном навыке конкретного технического писателя

Метод возвращает информацию о конкретном навыке конкретного технического писателя. Возвращается общая информация плюс опыт и подтверждающий документ для конкретного технического писателя

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	techwriterId	`integer`	path	Да	Идентификатор технического писателя, о навыке которого нужно получить информацию
2	skillId	`integer`	path	Да	Идентификатор навыка конкретного технического писателя, о котором нужно получить информацию

POST /techwriters/{techwriterId}/skills/{skillId}

Добавление навыка для определенного технического писателя

Метод добавляет конкретный навык для определенного технического писателя

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	techwriterId	`integer`	path	Да	Идентификатор технического писателя, которому добавляется навык
2	skillId	`integer`	path	Да	Идентификатор навыка

GET /skills

Получение информации о доступных в системе навыках

Метод возвращает информацию обо всех доступных в системе навыках

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	limit	`integer`	query	Нет	Количество навыков в выдаче (для пагинации). Значение по умолчанию `20`

POST /skills

Добавление навыка в базу

Метод добавляет новый навык в базу

GET /skills/{skillId}

Получение информации о навыке по идентификатору

Метод возвращает информацию о навыке по его идентификатору

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	skillId	`integer`	path	Да	Идентификатор навыка, о котором нужно получить информацию

PATCH /skills/{skillId}

Редактирование навыка

Метод изменяет описание навыка. Метод изменяет навык частично: можно передать только название, описание или алиас для изменения. Обязательно должен быть передан хотя бы один параметр

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	skillId	`integer`	path	Да	Идентификатор навыка, который нужно изменить

DELETE /skills/{skillId}

Удаление навыка из базы

Метод удаляет навык из базы по его идентификатору

Параметры:

№	Параметр	Тип	Расположение	Обязательный	Описание
1	skillId	`integer`	path	Да	Идентификатор навыка, который нужно удалить