Дизайн REST API [GetAnalyst] [Екатерина Ананьева]

Bot

Администратор
Команда форума
23 Янв 2020
142,283
503
113
Модуль 1. Введение в основы REST API
Модуль состоит из записей практических вебинаров. В нем вы познакомитесь с CRUD-моделью и научитесь правильно выбирать методы GET, POST, PUT, PATCH и DELETE в зависимости от контекста требований. Узнаете, как связаны модель базы данных и описание объектов данных REST API в формате JSON. Познакомитесь с инструментом тестирования REST API - Postman и сможете воспользоваться им на практике.
1. REST API: назначение и методы
2. Общие принципы разработки дизайна REST API
3. Про REST API за 90 минут: от теории к практике
4. Связь базы данных и дизайна REST API
5. Тестирование интеграционного взаимодействия: проверка методов REST API
6. 5 главных принципов дизайна REST API с документированием в Postman

Модуль 2. Программный интерфейс REST API
В результате знакомства с модулем Вы сможете без труда объяснить, что такое REST API и для чего его используют. Познакомитесь со структурой методов REST API, получите базовые навыки проектирования запросов и ответов. Узнаете про корпоративные стандарты для REST API и получите шаблон, который возьмете за основу для работы на курсе.

1. RESTful API
2. JSON
3. HTTP Headers
4. HTTP-коды ответов на запросы
5. Cookies
6 Гайд по дизайну REST API

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

1. Требования заказчика
2. Функциональные требования
3. Модель данных
4. Сценарии использования - методы REST API по CRUD-модели

Модуль 4. Разработка дизайна REST API для управления объектами данных (POST, GET, PATCH, PUT, DELETE)
В результате знакомства с модулем вы научитесь выделять объекты данных и описывать для них методы REST API в контексте бизнес-требований, делать JSON-структуры объектов. Создадите первые контракты REST API документации - дизайн REST API.

1. Подготовка к описанию дизайна REST API
2. Шаблон постановки задачи на метод REST API (описание методов)
3. POST
4. GET
5. PUT
6. PATCH
7. DELETE
8. Обработка ошибок REST API - практический пример

Модуль 5. Авторизация запросов REST API (Basic, Token, OAuth2.0)

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

1. Авторизация и аутентификация
2. Basic-аутентификация
3. Авторизация по ключу: токены
4. Авторизация OAuth 2.0

Модуль 6. Дизайн REST API - массивы и списки, синхронные и асинхронные запросы
Работа с массивами и списками. Пагинация. Фильтрация и сортировка. Синхронные и асинхронные запросы.

1. Массовые операции. Массивы
2. Синхронные и асинхронные запросы
3. POST
4. GET и PATCH
5. PUT
6. DELETE

Модуль 7. Инструменты разработки API-документации и тестирования программного интерфейса REST API
В результате освоения модуля вы получите навыки тестирования и разработки REST API-документации в инструментах Postman и Swagger.

1. Postman - инструмент тестирования и документирования REST API
2. Swagger - инструмент документирования REST API (освоение OpenAPI)

Модуль 8. Постановка задач на Backend разработчиков

Как использовать разработанные контракты - дизайн REST API для постановки задач на Backend-разработчиков.

1. Постановка задач на Backend-разработчиков