🟢🤖 Шаблон требований к REST API для Confluence + примеры использования 🔖


👉 Ключевое в шаблоне REST API:
✔️ Общее описание
✔️ Доступы
✔️ Ограничения
✔️ Запрос: HTTP-метод, URL, query, headers, body (json)
✔️ Успешный ответ: HTTP-код, headers, body (json)
✔️ Ошибочные ответы: HTTP-код, headers, body (json)
✔️ Требования к реализации - алгоритм
✔️ Маппинг данных (API - БД - Внешние API для интеграций)



👉 Зачем нужен шаблон требований на REST API методы?

1️⃣ Разработчики быстрее ориентируются в задаче
Они понимают, где искать бизнес-логику, параметры запроса, тело запроса, ответы, ошибки, ограничения и примеры.

2️⃣ Постановка задачи сразу становится основой будущей документации

3️⃣ Системный аналитик не упускает требования и всегда держит единую структуру документа.

🤖 Автоматизировать постановку задач на новые методы с помощью кастомизированных AI-агентов
Про это буду рассказывать в следующих постах 🔥

Этих 4-х пунктов достаточно, чтобы понять цель шаблона:
▫️ повысить качество постановок задач и документации
▫️ автоматизировать свою работу с AI



🔖 Примеры требований — выгрузки готовых задач из Confluence по шаблону:
🔗 Cоздание товара - POST /products
🔗 Редактировать товар - PUT /products/{productId}
🔗 Создать мероприятие - POST /events
🔗 Получить рецепт - GET /recipes/{recipeId}
🔗 Получить список книг - GET /books

К посту добавила выгрузку шаблона из Confluence.
Также в нашем блоге можно найти статью с пояснениями к нему.

Забирайте, пользуйтесь 🤝

#ResApiGa

📱 Tg | 💙 ВК | 💬 Max