REST API — стандарт в большинстве IT-проектов. Поэтому глубокое понимание его работы и принципов проектирования уже давно спрашивают с аналитиков.
Но даже опытные специалисты часто допускают ошибки: нюансов в проектировании больше, чем кажется.
Чтобы разобраться в них на практике, приглашаем на открытый урок:
🐞 Как избежать ошибок в REST API:
🗓 Доступ 2 - 5 августа [сб-вт]
👉 Подробности и регистрация
План:
1. Теория по REST API на практике в Postman
2. 5 ошибок проектирования REST API
3. Шаблон постановки задачи на API
4. AI-инструменты для работы
Этот открытый урок даст вам и теоретические знания, и практические инструменты 🛠
Будем погружаться в сложную теорию через реальную работу и разбор конкретных примеров.
Занятие проводится как вводный урок к практической программе Дизайн REST API.
Регистрируйтесь, чтобы не пропустить! 😉
Please open Telegram to view this post
VIEW IN TELEGRAM
❤19❤🔥6🔥2
📚 Что почитать и посмотреть по REST API: подборка материалов от GetAnalyst 📚
У нас много новых участников в сообществе 🙌 И…!
Вместо того, чтобы рассказывать о себе, сделала для вас самую полную и актуальную подборку полезных материалов по проектированию REST API.
Так вы лучше узнаете меня - Екатерину Ананьеву - не на словах, а в деле 🙂
Материалы расположены по порядку - от простого к сложному.
Они помогут вам сделать крутой прорыв в освоении темы и разобраться в сложных вопросах.
(С) Структура метода REST API
(В) Postman: навык тестирования REST API за вечер
(С) Методы HTTP (REST) и их назначение
(C) Как строить URL в REST API
(C) Всё про JSON в одной картинке
(С) Мини-книга про JSON
(В) Связь БД и дизайна REST API
(С) Headers
(С) 6 способов пагинации
(С) Проектирование ошибок в REST API
(В) Проект “Система для автосервиса” - видео-обучение:
1. Сбор бизнес-требований, погружение в контекст
2. Определение сущностей и проектирование логической модели БД
3. REST API с нуля: дизайн методов для работы менеджера с заявками автосервиса
(С) 6 ключевых принципов REST API - теория, но спрашивают понимание
(C) Postman: Практическое руководство с примером тестирования открытого API DaData
(С) Postman: Практическое руководство с примером - API DaData - ещё один сервис
(C) Postman: Практическое руководство с примером - платежная система ВТБ
(П) Вопросы и ответы по REST API: собеседование на СА
(В) Собеседование на СА: разбор задачи на асинхронные запросы в REST API
(C) Шаблон постановки задачи на REST API метод
(П) gRPС vs REST - что выбрать для проекта
(C) Проектирование REST API: спорные вопросы с проектов и собеседований на системного аналитика (и не только)
(С) Исследование реальных REST API на соответствие REST: Trello, Todoist
Также вы можете найти у нас мини-обучения и продвинутую практическую программу Дизайн REST API для опытных аналитиков.
(В) Видео
(П) Подкасты
(С) Статьи
Делитесь с коллегами, особенно с джунами и мидлами СА!
Сохранили? ❤️
#RestApiGA
У нас много новых участников в сообществе 🙌 И…!
Вместо того, чтобы рассказывать о себе, сделала для вас самую полную и актуальную подборку полезных материалов по проектированию REST API.
Так вы лучше узнаете меня - Екатерину Ананьеву - не на словах, а в деле 🙂
Материалы расположены по порядку - от простого к сложному.
Они помогут вам сделать крутой прорыв в освоении темы и разобраться в сложных вопросах.
(С) Структура метода REST API
(В) Postman: навык тестирования REST API за вечер
(С) Методы HTTP (REST) и их назначение
(C) Как строить URL в REST API
(C) Всё про JSON в одной картинке
(С) Мини-книга про JSON
(В) Связь БД и дизайна REST API
(С) Headers
(С) 6 способов пагинации
(С) Проектирование ошибок в REST API
(В) Проект “Система для автосервиса” - видео-обучение:
1. Сбор бизнес-требований, погружение в контекст
2. Определение сущностей и проектирование логической модели БД
3. REST API с нуля: дизайн методов для работы менеджера с заявками автосервиса
(С) 6 ключевых принципов REST API - теория, но спрашивают понимание
(C) Postman: Практическое руководство с примером тестирования открытого API DaData
(С) Postman: Практическое руководство с примером - API DaData - ещё один сервис
(C) Postman: Практическое руководство с примером - платежная система ВТБ
(П) Вопросы и ответы по REST API: собеседование на СА
(В) Собеседование на СА: разбор задачи на асинхронные запросы в REST API
(C) Шаблон постановки задачи на REST API метод
(П) gRPС vs REST - что выбрать для проекта
(C) Проектирование REST API: спорные вопросы с проектов и собеседований на системного аналитика (и не только)
(С) Исследование реальных REST API на соответствие REST: Trello, Todoist
Также вы можете найти у нас мини-обучения и продвинутую практическую программу Дизайн REST API для опытных аналитиков.
(В) Видео
(П) Подкасты
(С) Статьи
Делитесь с коллегами, особенно с джунами и мидлами СА!
Сохранили? ❤️
#RestApiGA
❤37🔥10👏1👀1
✅ 1. Общее описание
+ что делает этот метод?
+ для кого он?
+ почему мы его делаем?
✅ 2. Алгоритм работы - Use Case
+ основной сценарий
+ обработка ошибок
Требования к реализации:
✅ 3. Тип метода и полный URL
✅ 4. Query-параметры и их логика
✅ 5. Headers и их логика
✅ 6. Body (json) - Тело запроса
✅ 7. Аутентификация и авторизация запросов
✅ 8. Описание успешного ответа:
+ HTTP-статус код
+ Headers
+ Body (json) - тело ответа
✅ 9. Список обрабатываемых ошибок:
+ HTTP-статус код
+ Headers
+ Body (json) - тело ответа
Не описали ошибку? Значит её обработка не поддерживается.
Перечисленные выше требования (3-9) часто описывают с примерами запросов и ответов. Это самый лучший способ.
✅ 10. Маппинг данных для параметров API с БД
В маппинг включают: path-параметры, query-параметы, json-ы запроа и ответа, headers (если требуется).
✅ + 11. НФТ
Например, ограничения на кол-во запросов с одного ip или от одного клиента.
✅ + 12. Логирование и мониторинг
+ что логировать и где
+ при каких условиях, либо всегда
+ как долго хранить логи
+ требования к дашбордам мониторинга
✅ + 13. Дополнительно
+ Ответственная команда
+ Известные ошибки и проблемы
+ Требования к монетизации
+ Требования к кэшированию
+ Cookies - можно, но не нужно, они не рекомендуются для REST API
📌 Используйте пост как чеклист.
Проверьте, что у вас на работе учитываются все необходимые разделы в постановке задачи.
🧐 Что делают разработчики по тем пунктам, где требования сейчас не описываются, как принимают решения?
Этот чек-лист поможет задать правильные вопросы и избежать «дырок» в описании требований.
А если хочется дополнительных пояснений по наполнению, то можно почитать нашу статью Структура постановки задачи на REST API метод.
Сохраняйте, чтобы не потерять
#RestApiGA
Please open Telegram to view this post
VIEW IN TELEGRAM
❤41👍8❤🔥7🔥3🤩2👀1
GetAnalyst_Пример_постановки_задачи_на_REST_API_метод_Создать_встречу.pdf
1.1 MB
Теория - хорошо, а практика ещё лучше.
Для нашего проекта MeetsGA подготовила пример постановки задачи на метод:
POST /events - создать мероприятие
Изучайте и используйте для работы.
Описание шаблона можно найти тут, и в предыдущем посте 😌
#RestApiGA #MeetsGA
Please open Telegram to view this post
VIEW IN TELEGRAM
👍18❤🔥9❤6👀1
🔥 [Только 2-5 августа] REST API: от практики в Postman до помощи AI-ассистента 🔥
Нужно получить опыт работы с REST API?
+ Научиться проектировать сложные API-методы с нуля и учитывать все нюансы?
+ Избегать типичных ошибок в дизайне?
+ За секунды генерировать спецификации и шаблоны с помощью AI-ассистента?
Вам сюда 👇
🐞 Как избежать ошибок в REST API:
🤖 от практики в Postman до помощи AI-ассистента
🗓 Доступ 2 - 5 августа [сб-вт]
🕘 Время на обучение: 4 часа
👉 Подробности и регистрация
В результате этого бесплатного обучения:
✅ Получите опыт работы с Postman.
✅ Сделаете рабочую Postman-коллекцию для личного портфолио.
✅ Будете знать типичные ошибки при дизайне REST API и как их избежать.
✅ Получите примеры корректных постановок задач на API-методы.
✅ Научитесь использовать ChatGPT на продвинутом уровне для ускорения работы.
Регистрируйтесь и планируйте время на обучение заранее 🤝
Нужно получить опыт работы с REST API?
+ Научиться проектировать сложные API-методы с нуля и учитывать все нюансы?
+ Избегать типичных ошибок в дизайне?
+ За секунды генерировать спецификации и шаблоны с помощью AI-ассистента?
Вам сюда 👇
🐞 Как избежать ошибок в REST API:
🗓 Доступ 2 - 5 августа [сб-вт]
🕘 Время на обучение: 4 часа
👉 Подробности и регистрация
В результате этого бесплатного обучения:
✅ Получите опыт работы с Postman.
✅ Сделаете рабочую Postman-коллекцию для личного портфолио.
✅ Будете знать типичные ошибки при дизайне REST API и как их избежать.
✅ Получите примеры корректных постановок задач на API-методы.
✅ Научитесь использовать ChatGPT на продвинутом уровне для ускорения работы.
Регистрируйтесь и планируйте время на обучение заранее 🤝
Please open Telegram to view this post
VIEW IN TELEGRAM
❤19
🟢🟠 Инструменты для работы с API: полный гайд для СА 🟡🟣
Зачем аналитику знать инструменты для тестирования и документирования API?
👉 Интеграции:
СА необходимо убедиться, что API внешней системы будет работать именно так, как описано в документации (если она есть, а если нет - то составить), чтобы затем предоставить информацию разработчикам.
Тестирование API внешних систем в специализированных инструментах помогает выявить проблемы в работе внешних систем на ранних стадиях разработки, несоответствия документации реальности, а также проверить полноту данных и доступность сервисов в целом.
👉 Backend-команды, которым нужно ставить задачи на API:
Нужно уметь самому с нуля проектировать и документировать API, желательно с использованием специализированных инструментов как Postman и Swagger, а не только в Confluence-подобных системах.
Список инструментов, которые помогают системным аналитикам в тестировании и документировании API:
🟠 Postman
🟡 SoapUI
🟣 Insomnia
🟢 Swagger
Подробности в картинках к посту ☝️
+🐶 Bruno - аналог Postman, всё больше завоёвывает сердца аналитиков, его нет в картинках к посту.
👉 Рекомендую поработать со всеми инструментами и выбрать наиболее удобный для себя.
Делюсь практическими гайдами, с которыми вы сможете поработать с инструментами сами, с понятными пошаговыми инструкциями:
▫️ Postman: Практическое руководство с примером тестирования открытого API
▫️ GraphQL — знакомство на практике через Postman [пошаговая инструкция]
▫️ Postman: навык тестирования REST API за вечер
▫️ Swagger - практическое руководство по документированию API
Пользуйтесь! 🤩
#RestApiGA
Зачем аналитику знать инструменты для тестирования и документирования API?
👉 Интеграции:
СА необходимо убедиться, что API внешней системы будет работать именно так, как описано в документации (если она есть, а если нет - то составить), чтобы затем предоставить информацию разработчикам.
Тестирование API внешних систем в специализированных инструментах помогает выявить проблемы в работе внешних систем на ранних стадиях разработки, несоответствия документации реальности, а также проверить полноту данных и доступность сервисов в целом.
👉 Backend-команды, которым нужно ставить задачи на API:
Нужно уметь самому с нуля проектировать и документировать API, желательно с использованием специализированных инструментов как Postman и Swagger, а не только в Confluence-подобных системах.
Список инструментов, которые помогают системным аналитикам в тестировании и документировании API:
🟠 Postman
🟡 SoapUI
🟣 Insomnia
🟢 Swagger
Подробности в картинках к посту ☝️
+
👉 Рекомендую поработать со всеми инструментами и выбрать наиболее удобный для себя.
Делюсь практическими гайдами, с которыми вы сможете поработать с инструментами сами, с понятными пошаговыми инструкциями:
▫️ Postman: Практическое руководство с примером тестирования открытого API
▫️ GraphQL — знакомство на практике через Postman [пошаговая инструкция]
▫️ Postman: навык тестирования REST API за вечер
▫️ Swagger - практическое руководство по документированию API
Пользуйтесь! 🤩
#RestApiGA
Please open Telegram to view this post
VIEW IN TELEGRAM
Please open Telegram to view this post
VIEW IN TELEGRAM
❤35👍4🔥3👏2
🔐 Авторизация и аутентификация в REST API: что, зачем и как 🔐
▫️ Аутентификация (Authentication) — подтверждение, что это действительно тот клиент / пользователь, за кого он себя выдаёт.
Проверяется при входе в систему, когда пользователь предоставляет ключи доступа:
+ логин+пароль
+ токен
Если аутентификация не пройдена, то API должен вернуть ошибку HTTP-401.
▫️ Авторизация (Authorization) — проверка прав аутентифицированного клиента: что ему можно, а что нет.
При выполнении очередного действия в системе, например - удаление мероприятия в календаре, надо проверить, что у него есть права на это (он его создал, оно в его календаре).
Если нет прав, то API должен вернуть ошибку HTTP-403.
▫️ Основные схемы аутентификации
🔑 API-ключи
• Простая пара «ключ=значение» в заголовке X-API-Key.
• Быстро настраивается, но статичен и часто уязвим (нет ротации, нет TTL).
Пример Header:
🔒 HTTP Basic Auth
• Передаёт логин/пароль закодированным в Base64 в заголовке Authorization: Basic <credentials>.
• Использовать только по HTTPS.
Пример Header:
🚀 JWT (JSON Web Token)
• Короткоживущий токен с подписанным payload’ом (claims).
• Передача в заголовке Authorization: Bearer <token>.
• Удобен для распределённых систем: нет обращений к БД при каждом запросе.
🌐 OAuth 2.0
• Полноценный фреймворк (стандарт) для выдачи и обновления токенов: Access + Refresh Token.
• Подходит для публичных API и сторонних интеграций.
• Поддерживает разные гранты (Client Credentials, Authorization Code и другие).
▫️ В описании API-метода обязательно указать:
+ какую схему аутентификации поддерживаем
+ формат токена (JWT, UUID и т.д.)
+ куда передавать (заголовок, query-параметр, cookie)
+ список возможных ошибок и их тело (JSON-ответ)
🎧 Подкаст и статья тут 🙂
#RestApiGA
▫️ Аутентификация (Authentication) — подтверждение, что это действительно тот клиент / пользователь, за кого он себя выдаёт.
Проверяется при входе в систему, когда пользователь предоставляет ключи доступа:
+ логин+пароль
+ токен
Если аутентификация не пройдена, то API должен вернуть ошибку HTTP-401.
▫️ Авторизация (Authorization) — проверка прав аутентифицированного клиента: что ему можно, а что нет.
При выполнении очередного действия в системе, например - удаление мероприятия в календаре, надо проверить, что у него есть права на это (он его создал, оно в его календаре).
Если нет прав, то API должен вернуть ошибку HTTP-403.
▫️ Основные схемы аутентификации
🔑 API-ключи
• Простая пара «ключ=значение» в заголовке X-API-Key.
• Быстро настраивается, но статичен и часто уязвим (нет ротации, нет TTL).
Пример Header:
X-API-Key: 123e4567-e89b-12d3-a456-426614174000
🔒 HTTP Basic Auth
• Передаёт логин/пароль закодированным в Base64 в заголовке Authorization: Basic <credentials>.
• Использовать только по HTTPS.
Пример Header:
Authorization: Basic bXlVc2VyOm15UGFzc3dvcmQ=
🚀 JWT (JSON Web Token)
• Короткоживущий токен с подписанным payload’ом (claims).
• Передача в заголовке Authorization: Bearer <token>.
• Удобен для распределённых систем: нет обращений к БД при каждом запросе.
🌐 OAuth 2.0
• Полноценный фреймворк (стандарт) для выдачи и обновления токенов: Access + Refresh Token.
• Подходит для публичных API и сторонних интеграций.
• Поддерживает разные гранты (Client Credentials, Authorization Code и другие).
▫️ В описании API-метода обязательно указать:
+ какую схему аутентификации поддерживаем
+ формат токена (JWT, UUID и т.д.)
+ куда передавать (заголовок, query-параметр, cookie)
+ список возможных ошибок и их тело (JSON-ответ)
Нужно глубже погрузиться в тему аутентификации
и авторизации в API?
🎧 Подкаст и статья тут 🙂
#RestApiGA
❤26🔥8
Бесплатное практическое занятие по REST API + Postman + AI [2 - 5 августа]👇
Этот открытый урок сэкономит вам кучу времени и нервов, как на изучение REST API, так и на реальную работу с ним, если вы научитесь использовать AI.
🐞 Как избежать ошибок в REST API:
🤖 от практики в Postman до помощи AI-ассистента
🗓 Доступ 2 - 5 августа [сб-вт]
🕘 Время на обучение: 4 часа
👉 Подробности и регистрация
План:
1. Теория по REST API на практике - через Postman
2. Практика на выявление ошибок проектирования
3. Как вести проектную API-документацию: шаблоны и важные рекомендации
4. AI-ассистент при проектировании REST API
---------------
Подготовка:
Перед занятием установите Postman и зарегистрируйте аккаунт в нём!
Попробуйте сделать Workspace и первую коллекцию.
Всё остальное покажем во время урока.
Инструкция по Postman с нуля
---------------
Это занятие — бесплатный вводный урок к практической программе Дизайн REST API.
Регистрируйтесь, планируйте время на обучение и совершенствуйте свои навыки! 🚀
Этот открытый урок сэкономит вам кучу времени и нервов, как на изучение REST API, так и на реальную работу с ним, если вы научитесь использовать AI.
🐞 Как избежать ошибок в REST API:
🗓 Доступ 2 - 5 августа [сб-вт]
🕘 Время на обучение: 4 часа
👉 Подробности и регистрация
План:
1. Теория по REST API на практике - через Postman
2. Практика на выявление ошибок проектирования
3. Как вести проектную API-документацию: шаблоны и важные рекомендации
4. AI-ассистент при проектировании REST API
---------------
Подготовка:
Перед занятием установите Postman и зарегистрируйте аккаунт в нём!
Попробуйте сделать Workspace и первую коллекцию.
Всё остальное покажем во время урока.
Инструкция по Postman с нуля
---------------
Это занятие — бесплатный вводный урок к практической программе Дизайн REST API.
Регистрируйтесь, планируйте время на обучение и совершенствуйте свои навыки! 🚀
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥17❤10
Привет! Сегодня расскажу про свою учёбу по AI в Harvard 🎓
Начну с того, что это не только про «узнать что-то новое». Многое уже давно знакомо.
Но даже те знания, которые у меня уже были, раскрываются с совершенно другой стороны 🤩
Что особенно цепляет:
— новые реальные примеры использования AI,
— обсуждение, какие IT-продукты выживут, а какие уже «в зоне риска»,
— куда всё идёт и как готовиться.
👉 Важные моменты, которыми хочу поделиться:
📌 Инсайт 1:
Выиграли те, кто это понял раньше всех: Google, Amazon, Netflix, Яндекс, и т.д.
Теперь та же история, только с когнитивными способностями:
Простые задачи он уже берёт на себя. И это только начало.
ChatGPT и подобные продукты — аналог браузера.
А что дальше?
Пока мы только на пороге зарождения AI-компаний, и настоящих передовых AI-продуктов пока нет.
📌 Инсайт 2:
Не потому что «AI всех заменит», а потому что с ним можно делать больше, быстрее и точнее. Он повышает продуктивность.
На это уже смотрят при найме в ведущих IT-компаниях.
📌 Инсайт 3:
Был отдельный раздел про галлюцинации AI.
Важная мысль:
Он создан не для «найти ответ», а для «придумать что-то новое».
Это Generative AI (генеративный икусственный интеллект). От слова генерировать = создавать. Но не искать 😅
Жалобы «какую-то ерунду ответил, опять не то, опять придумал» — это просто недопонимание того, как работает генеративный AI.
Он не ищет, он генерирует.
Поэтому и ответы у нас с вами разные.
Тем не менее.... 😄
Это самый популярный Use Case. И под поиск ChatGPT добавил отдельный режим. Если пользуетесь им как поисковиком - включать его.
👉 Я работаю над проектом по внедрению AI в образование.
Учёба идёт интенсивно, времени уходит много — но это именно тот путь, который мне интересен.
Каждый день ощущаю, что становлюсь сильнее как специалист (= лучшей версией себя).
Радуюсь новым шагам 🙌
Начну с того, что это не только про «узнать что-то новое». Многое уже давно знакомо.
Но даже те знания, которые у меня уже были, раскрываются с совершенно другой стороны 🤩
Что особенно цепляет:
— новые реальные примеры использования AI,
— обсуждение, какие IT-продукты выживут, а какие уже «в зоне риска»,
— куда всё идёт и как готовиться.
👉 Важные моменты, которыми хочу поделиться:
📌 Инсайт 1:
Когда появились браузеры и интернет — доступ к информации стал дешевле.
Выиграли те, кто это понял раньше всех: Google, Amazon, Netflix, Яндекс, и т.д.
Теперь та же история, только с когнитивными способностями:
AI делает доступ к мышлению дешевле.
Простые задачи он уже берёт на себя. И это только начало.
ChatGPT и подобные продукты — аналог браузера.
А что дальше?
Пока мы только на пороге зарождения AI-компаний, и настоящих передовых AI-продуктов пока нет.
📌 Инсайт 2:
Те, кто умеют использовать ИИ — будут на шаг впереди.
Не потому что «AI всех заменит», а потому что с ним можно делать больше, быстрее и точнее. Он повышает продуктивность.
На это уже смотрят при найме в ведущих IT-компаниях.
📌 Инсайт 3:
Был отдельный раздел про галлюцинации AI.
Важная мысль:
ChatGPT — не поисковик.
Он создан не для «найти ответ», а для «придумать что-то новое».
Это Generative AI (генеративный икусственный интеллект). От слова генерировать = создавать. Но не искать 😅
Жалобы «какую-то ерунду ответил, опять не то, опять придумал» — это просто недопонимание того, как работает генеративный AI.
Он не ищет, он генерирует.
Поэтому и ответы у нас с вами разные.
Тем не менее.... 😄
Это самый популярный Use Case. И под поиск ChatGPT добавил отдельный режим. Если пользуетесь им как поисковиком - включать его.
👉 Я работаю над проектом по внедрению AI в образование.
Учёба идёт интенсивно, времени уходит много — но это именно тот путь, который мне интересен.
Каждый день ощущаю, что становлюсь сильнее как специалист (= лучшей версией себя).
Радуюсь новым шагам 🙌
🔥70👏15❤10👍6❤🔥1😁1
🟠🤖 Только до завтра: доступ к бесплатной практике по REST API + Postman + AI 🤖🟠
Тема:
Как избежать ошибок в REST API:
от практики в Postman до помощи AI-ассистента
Доступ:
до 5 августа 23:59 Мск [вт]
Время на обучение:
4 часа
👉 Подробности и регистрация
Ваша обратная связь👇
«Очень полезная информация, много подчеркнул и взял на заметку, спасибо огромное!»
— Артём
«Интересно, полезно, на практике всё намного быстрее доходит. Спасибо за такой полезный урок!»
— Полина
«Всё кратко изложено по теме и разложено по полочкам»
— Андрей
👇
Этот урок — первый шаг к практической программе «Дизайн REST API» для аналитиков, где вы:
— научитесь проектировать методы,
— разберётесь в нюансах передачи данных и обработки ошибок,
— закрепите знания на практике,
— получите опыт работы в Postman и Swagger (OpenAPI),
— научитесь использовать ChatGPT как помощника в проектировании API.
💡 Первое онлайн-занятие состоится в следующий вторник!
До 5 августа действует специальная цена, а также:
+3 месяца доступа в подарок
+3 онлайн-встречи по второму проекту
Успейте присоединиться, пока открыта регистрация!
👉 Узнать о программе REST API
Тема:
Как избежать ошибок в REST API:
от практики в Postman до помощи AI-ассистента
Доступ:
до 5 августа 23:59 Мск [вт]
Время на обучение:
4 часа
👉 Подробности и регистрация
Ваша обратная связь👇
«Очень полезная информация, много подчеркнул и взял на заметку, спасибо огромное!»
— Артём
«Интересно, полезно, на практике всё намного быстрее доходит. Спасибо за такой полезный урок!»
— Полина
«Всё кратко изложено по теме и разложено по полочкам»
— Андрей
👇
Этот урок — первый шаг к практической программе «Дизайн REST API» для аналитиков, где вы:
— научитесь проектировать методы,
— разберётесь в нюансах передачи данных и обработки ошибок,
— закрепите знания на практике,
— получите опыт работы в Postman и Swagger (OpenAPI),
— научитесь использовать ChatGPT как помощника в проектировании API.
💡 Первое онлайн-занятие состоится в следующий вторник!
До 5 августа действует специальная цена, а также:
+3 месяца доступа в подарок
+3 онлайн-встречи по второму проекту
Успейте присоединиться, пока открыта регистрация!
👉 Узнать о программе REST API
❤13👍2🥰1
🙌 Как выглядит идеальная API-документация в Postman для портфолио СА? 🙌
1️⃣ Есть общее описание проекта.
2️⃣ Есть информация о способе авторизации запросов.
3️⃣ Используются переменные окружения — удобно для переключения между средами.
4️⃣ У каждого метода есть описание: что делает, кому доступен, ограничения.
5️⃣ Приведены примеры всех возможных ответов:
и успешных,
и ошибочных.
6️⃣ Примеры JSON-запросов и ответов — реалистичные.
7️⃣ Headers настроены там, где это требуется.
8️⃣ В демо документации показано только 2 метода — для портфолио желательно не менее 10 📌
Образец документации для проекта #MeetsGA в открытом доступе:
📎 https://documenter.getpostman.com/view/20545501/2sB3BANYdP
Метод создания встречи аккуратно перенесён из Confluence.
Все методы оформлены так, как должно быть в идеальном портфолио системного аналитика 🙌
Да и не только в портфолио, а конечно же и в ваши проектах!
🟠 По нажатию на "Run in Postman" вы можете открыть Postman-коллекцию и посмотреть как она была создана.
Сохраняйте и используйте как пример для своих проектов 🤝
#RestApiGA
1️⃣ Есть общее описание проекта.
2️⃣ Есть информация о способе авторизации запросов.
3️⃣ Используются переменные окружения — удобно для переключения между средами.
4️⃣ У каждого метода есть описание: что делает, кому доступен, ограничения.
5️⃣ Приведены примеры всех возможных ответов:
и успешных,
и ошибочных.
6️⃣ Примеры JSON-запросов и ответов — реалистичные.
7️⃣ Headers настроены там, где это требуется.
8️⃣ В демо документации показано только 2 метода — для портфолио желательно не менее 10 📌
Образец документации для проекта #MeetsGA в открытом доступе:
Метод создания встречи аккуратно перенесён из Confluence.
Все методы оформлены так, как должно быть в идеальном портфолио системного аналитика 🙌
Да и не только в портфолио, а конечно же и в ваши проектах!
🟠 По нажатию на "Run in Postman" вы можете открыть Postman-коллекцию и посмотреть как она была создана.
Сохраняйте и используйте как пример для своих проектов 🤝
#RestApiGA
Please open Telegram to view this post
VIEW IN TELEGRAM
Please open Telegram to view this post
VIEW IN TELEGRAM
👏22❤19👍6