💙 Образец постановки задачи на REST API: заполненный шаблон для Confluence 💙

Шаблон постановки задачи гарантирует то, что вы сможете всё учесть по структуре и ничего не потеряете.

Но я искренне понимаю всех, кто еще ни разу не работал с постановками задач на Backend (REST API), и, даже глядя на шаблон, слабо представляет что туда писать 🥲

Поэтому я оформила постановку задачи по проекту #ElibraGA на метод GET /books - получение списка книг.

Теперь у вас есть образец, на который можно подглядывать 🙂


На что обратить внимание:
1. Headers: показала, какие могут быть для запроса, включая авторизацию.
2. Query-parameters: подробно расписала всё про фильтры запроса, их ограничения и связь с БД.
3. API name: уточнила, что метод может использоваться и для админского API, с аналогичной реализацией.
4. Ответы: дала примеры двух успешных ответов, включая пустой список, и описала все ошибки.
5. Требования к реализации: подробно расписала алгоритм для разработчиков, включая исключительную ситуацию с элементами пагинации.


Используемая информация для подготовки:
▫️ шаблон постановки задачи на REST API метод
▫️ БД и дизайн проекта
▫️ пример 9 методов по проекту (сделала улучшение, чтобы сразу был список авторов и список жанров)


Создано с заботой о тех, кто только начинает свой путь в REST API,
и для опытных аналитиков, кто ищет примеры для внедрения в свою работу.

Сохраняйте и пользуйтесь 💙

#RestApiGA