Как сформировать список запросов для реализации апи на бэкенде?

Question

[Pavell89]

Есть уже готовый дизайн мобильного приложения интернет магазина.
Бекендщик просит подготовить ему запросы для того чтобы он реализовал API на существующем веб магазине дня приложения

Подскажите, как это лучше организовать и в каком виде? С чего начать?
Этим должен заниматься разработчик приложения?

Answer 1

[xmoonlight]

Делаете таблицу:
1. URL вызова функции API
2. Назначение
3. Метод вызова
4. Параметры запроса
5. Коды ответа
6. Примеры ответов при удачном исходе
7. Примеры ответов при ошибках

Этим должен заниматься разработчик (архитектор) приложения.
Бэкендщик - только проверяет и корректирует.
Оба - договариваются об общении между сервером и приложением между собой.

Answer 2

[Иван Шумов]

Этим должен заниматься человек, который руководит командой и знает обе части системы. Если такого нет то надо садиться вместе и обсуждать это. Результатом подобной работы, как правило, является документ OpenAPI (Swagger). Можно прямо у них на сайте и набросать

Answer 3

[Владимир Коротенко]

Дизайн не делает запросы к api.

Но попытаюсь вам помочь.

Напишите список страниц. Под каждым экраном опишите действия,

Логин
/api/signin - post
email
password

/api/register - post
email
password

Список выстрелов
/api/shots - get
список отстрелов , с полями место, длительность серии, количество в серии, примечания
/api/shots/num - get
детализация отстрела
/api/shots/num - del
удаление
/api/shots - post
создание

Запись отстрела
Настройки
/api/settings - get
windowSize - целое
safeWindow - целое
multiply - float