​​Мини-курс "Введение в API".Брайан Кукси
(перевод под редакцией Артема Стукалова и Дениса Бескова)

Содержание:
 ▪︎ Глава 1: Введение
 ▪︎ Глава 2: Протоколы
 ▪︎ Глава 3: Форматы данных
 ▪︎ Глава 4: Аутентификация, часть 1
 ▪︎ Глава 5: Аутентификация,  часть 2
 ▪︎ Глава 6: Проектирование API
 ▪︎ Глава 7: Связь в реальном времени
 ▪︎ Глава 8: Реализация

Скачать оригинал в формате PDF

#API | @notes_analyst

​​📑 Курс по документированию API.

(вольный перевод курса Documenting APIs: a guide for technical writers, составленного Томом Джонсоном, техническим писателем Amazon)

На курсе вы разберете API на составные части, узнаете о конечных точках, параметрах, типах данных, аутентификации, curl, JSON, командной строке, консоли разработчика Chrome, JavaScript и прочих деталях, связанных с REST API.

Модули курса:
▪︎ Введение в REST API
▪︎ Используем API как разработчики
▪︎ Документирование конечных точек
▪︎ Спецификация OpenAPI и Swagger
▪︎ Тестирование документации
▪︎ Концептуальные разделы
▪︎ Публикация документации
▪︎ Работа технического писателя
▪︎ Нативные библиотеки API
▪︎ Глоссарий API и источники
▪︎ Документирование кода

#api | @notes_analyst

​​📑 Список полезных статей и видео для изучения тестирования API

🔹️ Руководство по REST архитектуре

🔹️ 15 инструментов для тестирования API

🔹️Стратегия тестирования REST API: что именно вам нужно тестировать?

🔹️ Postman: от простого API-теста до конечного сценария

🔹️ Тестирование GET-запросов

🔹️JSON-объект - что это и как он устроен
...

➡️ Смотреть весь список

#тестирование #api | @notes_analyst

​​✅ API межсистемной интеграции: тест для аналитика

Многие системные аналитики и некоторые бизнес-аналитики сталкиваются с задачами разработки требований на интеграции информационных систем или описания уже реализованных технологий межсистемного взаимодействия. Проверить свои знания этих технологий вам поможет открытый тест. 

Перейти к тесту

#api | @notes_analyst

Шпаргалка по REST API

🖇 Скачать в формате pdf

#rest #api | @notes_analyst

​​📑 Как упростить жизнь за 312 коротких шагов: проектируем GraphQL API в микросервисной архитектуре

"Эта статья изначально создавалась как гайд по работе с GraphQL для инженеров Звука (системные аналитики, разработчики, QA). При этом статья может быть полезна всем, кто никогда не работал с GraphQL, но очень хочет понять, зачем он может быть нужен, и как поможет решить задачу вашего бизнеса"

Читать статью

#api #graphql | @notes_analyst

​​📑 Аутентификация в веб-API: пример и ликбез по Postman

Автор Анна Вичугова
"Аналитики часто путают понятия аутентификации и авторизации, которые действительно связаны между собой, но отличаются. Чтобы подчеркнуть эту разницу, сегодня я на практическом примере интернет-магазина расскажу про HTTP-ответы и виды аутентификации веб-API, доступные в Postman."

Читать статью

#api #postman | @notes_analyst

​​12 неочевидных правил проектирования REST API

"Раскрываем 12 кейсов проектирования спецификации REST API из практики redmadrobot, которые помогут сэкономить время для разработки. А также объясняем, почему стоит следовать подходу contract first — писать спецификацию прежде кода"

Читать статью

#api | @notes_analyst

​​📑 Как проектировать веб-API: 7 самых важных вопросов

Автор: Анна Вичугова
"При том, что проектирование и выбор решения относится к области ИТ-архитектора, иногда аналитику приходится решать подобные задачи, особенно в задачах интеграции информационных систем. Рассмотрим на примере интернет-магазина, на какие самые важные вопросы должен ответить аналитик при разработке требований и/или первоначальном проектировании веб-API."

Читать статью

#api #проектирование | @notes_analyst

​​📑 HTTP-запросы и ответы в REST API: практический пример

В статье автор предлагает рассмотреть наиболее частые коды HTTP-ответов на GET, POST, PUT, PATCH и DELETE-запросы на примере интернет-магазина.

Читать статью

#rest #api | @notes_analyst

​​📑 Пишем свой REST API на Python с Flask: подробный guide

"Как значения из форм браузера попадают в базу данных, в чем разница между телом и параметрами запроса и каким образом таблица БД связана с классом ООП-скрипта: пишем REST API своего веб-приложения на Python с СУБД SQLLite, фреймворком Flask и тестированием в Postman."

Читать статью

#rest #api | @notes_analyst

​​📑 Как мы делали API для облака

Авторы статьи, Вячеслав Шмельцер, backend-разработчик, и Рамиль Алешкин, Product Owner Консоли управления #CloudMTS, рассказывают, чем они руководствовались и на что обращали внимание при разработке API, чтобы сделать его функциональным, масштабируемым и удобным для пользователей.

Читать статью

#api | @notes_analyst

📑 Единый формат времени для приложения

Данная статья была написана Автором при работе в компании. Будет полезна для понимания времени разработчикам и аналитикам, а также для организации контрактов как best practice. Как выяснилось на практике, далеко не все представляют себе часовые пояса в разработке

Читать статью

#api | @notes_analyst

​​📑 Как документировать публичные API для продукта. Большой гайд, часть 1

От Автора: "В части 1 (этой статье) рассмотрим, почему и зачем вообще публичным API нужна документация, есть ли у нее какие‑то отличия от документации внутренних API, а также проанализируем и детально разберем различные подходы к ведению такой документации, попутно познакомившись поближе с полезными инструментами."

Читать статью

#документация #api | @notes_analyst

📑 Документирование API

Читать статью

#документация #api | @notes_analyst

​​📑 Postman: Основы тестирования API и первые шаги с инструментом

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

Читать статью

#api #postman | @notes_analyst