Часть 3. Разработка API
После внесения изменений в диаграмму компонентов — перейдем непосредственно к разработке нового API для предоставления метрик телеканалу. Разрабатывать новое API вам предстоит по шагам, которые вы изучили в уроке «Процесс проектирования API». Перейдем к вашим задачам.
Ваши задачи:
- Чтобы выполнить задание вам понадобятся заметки, которые вы делали в первой части. Разрабатывать API вы будете исходя из метрик, которые вам удалось выделить в интервью.
- Откройте шаблон для разработки API.
- Нажмите кнопку «Сохранить на Яндекс Диск». Файл с шагами для проектирования API сохранится в папке «Последние файлы».
- Откройте документ и заполните в нём представленные таблицы на основе информации о метриках из интервью.
В рабочем файле для вас подготовлены шаблоны:
- Таблицы Job Story
Составьте Job Story для API и выделите к каждой из них цифровую возможность. Помните, что используемые для разработки требований к API части шаблона Job Story определяют инициирующее событие (ситуация), необходимую цифровую возможность (мотивация) и ожидаемый результат. Цифровую возможность необходимо выделить по группе метрик, о которой говорил представитель телеканала в интервью. - Таблицы для определения действий, шагов и границ API.
Расширьте описание Job Stories с помощью действий и шагов действий, которые в свою очередь определят границы API, по цифровым возможностям, определенным в первой таблице. Не забудьте выделить участника и написать описание для каждого шага. После этого определите границы API, а именно сгруппируйте записи таблицы действий и их шагов. Разные группы в таблице можно выделить разными цветами. - Таблицы для моделирования профиля API
Заполните профиль API, который состоит из следующих элементов:- Название API.
- Краткое описание API.
- Вид API.
- Название операции. Название операции можно задавать как на русском, так и на английском языке.
- Краткое описание операции.
- Участники, которым доступно выполнение операции.
- Используемые для выполнения операции ресурсы. В ресурсах необходимо выделить значение “Метрики”, используемые для выполнения каждой операции.
- Детали операции.
- Таблицы Job Story
В столбце «Детали операции» записываются:
- Запрашиваемые (входные) и возвращаемые (выходные) ресурсы.
- Параметры запроса.
- Безопасность и идемпотентность.
- Синхронность или асинхронность.
Заполнение этого столбца является необязательной частью задания.
- Когда все таблицы будут заполнены, откройте доступ к редактированию: нажмите на кнопку «Настроить доступ», а затем — на кнопку «Скопировать ссылку».
