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

Кому подойдёт: Системным аналитикам. Чтобы расти в должности и доходе, получив опыт проектирования REST API, и без промедления отвечать на вопрос: «Когда использовать POST, а когда GET?». За счёт понимания принципа работы в резюме добавятся ключевые слова: REST API, JSON, Postman, Swagger, Архитектура систем. Бизнес-аналитикам и менеджерам проектов. Чтобы оценить сложность проекта и определить, сколько времени и ресурсов потребуется на разработку и реализацию API. Это поможет проследить за качеством выполненных работ и улучшит коммуникацию с разработчиками. Разработчикам. Чтобы разрабатывать программные интерфейсы в едином стиле, понимать и соблюдать принципы проектирования REST API, сократить потенциальный объём рефакторинга в будущем и с лёгкостью проходить технические собеседования на позицию backend-разработчика. Развивающимся компаниям. Чтобы повысить квалификацию действующих специалистов. В дальнейшем это позволит сохранять сотрудников, позволяя им развиваться внутри компании. Команда начнёт быстрее и эффективнее решать задачи, сохраняя высокое качество продукта. Предобучение. Обзор проектов по 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 Модуль 1. Знакомство с проектом. Основы REST API. CRUD-модель. Формирование эндпоинтов Практическое занятие для самостоятельного прохождения. В нем вы выполняете практику по индивидуальному проекту и знакомитесь с основной теорией. 1. Знакомство с проектом 2. Верхнеуровневая схема архитектуры проекта 3. База данных проекта 4. Дополнительно: Теория по проектированию БД и SQL 5. Тестирование по БД проекта MyMovie 6. REST API и протокол HTTP 7. CRUD-модель и ее связь с REST API 8. Формирование эндпоинтов REST API (HTTP-метод + URL) 9. Тестирование по основам REST API Модуль 2. Программный интерфейс REST API В результате знакомства с модулем Вы сможете без труда объяснить, что такое REST API и для чего его используют. Познакомитесь со структурой методов REST API, получите базовые навыки проектирования запросов и ответов. Узнаете про корпоративные стандарты для REST API и получите шаблон, который возьмете за основу для работы на курсе. 1. Определения API, REST API, RESTful API 2. REST API: структура методов и связь с протоколом HTTP 3. Методы REST API и CRUD-модель 4. Структура URL методов в REST API 5. Элементы пагинации 6. JSON 7. Практика: Разработка JSON-объектов 8. HTTP Headers 9. Кеширование в API 10. Квиз по Headers 11. Разбор квиза по Headers 12. HTTP-коды ответов на запросы 13. Тестирование по HTTP-кодам 14. Разбор квиза по HTTP-кодам 15. Cookies 16. Гайд по дизайну REST API Модуль 3.1 Разработка контрактов методов REST API: POST, GET Теоретический модуль для подготовки к онлайн-занятиям 3 и 4. В результате знакомства с модулем вы научитесь проектировать методы REST API, делать JSON-структуры для объектов. 1. Шаблон постановки задачи на метод REST API (описание методов) 2. База с заполненными шаблонами REST API 3. POST 4. GET 5. Практика POST 6. Практика GET Модуль 3.2 Разработка контрактов методов REST API: PATCH, PUT, DELETE Теоретический модуль для подготовки к онлайн-занятиям 3 и 4. В результате знакомства с модулем вы научитесь проектировать методы REST API, делать JSON-структуры для объектов. 1. Шаблон постановки задачи на метод REST API (описание методов) 2. База с заполненными шаблонами REST API 3. POST 4. GET 5. Практика POST 6. Практика GET 7. PATCH 8. DELETE Модуль 4. Знакомство с Postman и Insomnia - тестирование API В результате знакомства с модулем вы изучите самые распространенные способы авторизации запросов, выберете наиболее подходящий, и добавите информацию по правам доступа и авторизации запросов в вашу API-документацию. 1. Postman - инструмент тестирования и документирования API 2. Postman - тестирование DaData 3. Postman - тестирование ВТБ 4. Знакомство с Postman на практике - тестирование REST API Яндекс.Диска 5. Postman, Insomnia и AI для работы с REST API 6. Контрольное задание по Postman / Insomnia Модуль 5. Аутентификация и авторизация в API: Basic, API-Key, Token, OAuth 2.0 В результате знакомства с модулем вы изучите самые распространенные способы авторизации запросов, выберете наиболее подходящий, и добавите информацию по правам доступа и авторизации запросов в вашу API-документацию. 1. Авторизация и аутентификация 2. Авторизация в REST API и её настройка в Postman 3. Basic-аутентификация 4. Практика: Basic-аутентификация 5. Аутентификация по Token 6. Практика: Аутентификация по Token 7. Аутентификация по API-Key 8. Практика: API-Key 9. Практика: API-key в query-параметрах 10. Аутентификация OAuth 2.0 11. Погружение в OAuth 2.0: базы данных, архитектура, документация на внедрение 12. OAuth 2.0 - тестирование VK 13. *OAuth 2.0 - тестирование Яндекс.Диск (Grant Type = Authorization Code) 14. *OAuth 2.0 - тестирование Jira Модуль 6. Дизайн REST API - массивы и списки, синхронные и асинхронные запросы Работа с массивами и списками. Пагинация. Фильтрация и сортировка. Синхронные и асинхронные запросы. 1. Массовые операции. Массивы. Фильтрация. Сортировка 2. Синхронные и асинхронные запросы 3. POST 4. GET 5. PATCH и PUT 6. DELETE 7. Практика: разработка метода массового создания Модуль 7. Postman - продвинутый уровень Знакомство с инструментом тестирования и документирования API - Postman. 1. Ведение API-документации в Postman 2. Разработка интерактивной API-документации - создание Mock-сервера 3. 5 главных принципов дизайна REST API с документированием в Postman Модуль 8. Swagger (OpenAPI) Знакомство с инструментом документирования REST API - Swagger. 1. Как задавать вопросы по Swagger в чат поддержки Telegram 2. Первые шаги в Swagger и OpenAPI 3. Swagger - разработка API-документации по индивидуальному проекту 4. Swagger - инструмент документирования REST API (дополнительный урок) Модуль 9. Постановка задач на Backend разработчиков Как использовать разработанные контракты - дизайн REST API для постановки задач на Backend-разработчиков. 1. Постановка задач на Backend-разработчиков 2. Проектирование REST API через ChatGPT Чему вы научитесь 80% содержания курса составляют практические занятия, и уже через 2 месяца вы: Поймете основы REST API, когда и как его используют. Будете правильно определять, когда использовать методы: POST, GET, PUT, PATCH, DELETE. Освоите навык разработки дизайна REST API с нуля. Поймете влияние требований заказчика на проектирование REST API. Поймете, как связаны БД и структура JSON. Разработаете и опишете JSON-объекты. Познакомитесь со сценариями синхронного и асинхронного взаимодействия, научитесь правильно проектировать методы для его реализации. Создадите свои контракты REST API-документации, которые можно будет показать на собеседовании. Научитесь ставить задачи разработчикам. Сможете сделать корпоративный гайд по дизайну REST API. Освоите Postman и Swagger: для создания API-документации и тестирования REST API. Екатерина Ананьева. Больше 10 лет в IT. 60+ проектов. Помощь в запусках и запуск стартапов. Спикер международных конференций. Автор статей VC, HABR и образовательных программ