API-интерфейсов декодирования (REST) ​​для менеджеров по продуктам | by Ujval Bucha

Img Источник: The Saturday Evening Post

Менеджер по продукту и инженер-программист заходят в бар.

Они смотрят в меню и заказывают еду и напитки. Менеджер по продукту немного выпивает и разглагольствует инженеру о новой моде под названием «API».

Подвыпивший Инженер улыбается, когда официант обслуживает заказ и сообщает менеджеру, что только что сделал вызов API.

Смущенный ПМ спрашивает как?

Инженер берет ручку и салфетку, готовый ответить и объяснить любопытному ПМ.

Инженер — Следуйте за мной, я расскажу вам историю о человеке, эксклюзивном ресторане и шеф-поваре/владельце, который объяснит вам, что такое (REST) ​​API и как он работает!

Вечер — Ого! Давайте начнем эту вечеринку!

Инженер — Представьте, что вы идете в модный ресторан, доступный только для членов (скажем, ресторан яхт-клуба, в котором вы можете обедать, только если у вас есть членство в яхт-клубе). Вы получаете членство в клубе и, следовательно, можете пообедать в ресторане.

PM — Что это значит в смысле API?

Инженер — Это означает, что, как и в случае с модным рестораном, упомянутым выше, API-интерфейсы имеют некоторые эксклюзивные права в отношении того, кто может их использовать. Если вы хотите войти в ресторан, вам потребуется действующая членская карта вместе с удостоверением личности, чтобы ресторан Yacht Club пропустил вас внутрь. В технической терминологии вам потребуется ключей API или токен , чтобы пройти аутентификацию для использования API 9.0013 .

Инженер — Ладно, бро! Теперь, когда ты стал эксклюзивным членом воображаемого яхт-клуба, ты отведешь меня в воображаемый ресторан?

PM — Да конечно! Не подскажете адрес и как пройти к этому воображаемому ресторану?

Инженер — Ха-ха! Этот адрес называется « Endpoint »!

Иллюстрация : Так выглядит конечная точка — http://theyachtrestaurant. com/Menu

Инженер — Итак, теперь, когда мы приземлились в воображаемом ресторане «Яхт-клуб», что вы хотите сделать?

PM — Разве не очевидно? Закажем еду!

Инженер — Отлично! Итак, начните описывать свои действия в ресторане, а я обосную аналогию с API.

PM — ОК круто! Идя по этой сюжетной линии, во-первых, хотелось бы посмотреть, чему все они служат!

Инженер — Отлично. Вы только что использовали « Get Method ».

PM — Чувак, можешь сначала сказать мне, что это за метод?

Инженер — « Method » — это не что иное, как « Verb » или « Action », которые вы запрашиваете у API. API не такой умный, как вы, мистер PM, поэтому нам нужно предоставить некоторые инструкции. Мы должны быть очень вежливы и « Запрос ’ API, чтобы сделать что-то для нас. Чтобы API заработали, вам нужно будет отправить некоторые инструкции в полезной нагрузке « Request ». После обработки « Request » вы получаете полезную нагрузку « Response » от API, которая предоставляет вам выходные данные и информацию о результатах.

PM — Итак, в примере, где я прошу официанта принести меню, чтобы я мог видеть, что они подают, как бы вы разбили его на терминологию API?

Инженер — Вот:

а. Method = Get

По аналогии с API метод GET используется для получения данных с сервера в указанном ресурсе. В этом сценарии вы попросили официанта принести вам список блюд, подаваемых в ресторане.

Запрос: Это означает, что вы запрашиваете некоторую информацию из базы данных. В этом случае вы запросили список блюд, подаваемых в ресторане

Ответ: Официант подает вам меню. Результатом ответа является то, что вы получаете меню, которое показывает вам список блюд, подаваемых в ресторане.

Позвольте мне проиллюстрировать API:

  Конечная точка : http://theimaginaryyachtclubrestaurant.com/Menu?itemType=All  Метод:  Получить 
  Тело запроса  :Нет 
 1 6  0 Тело ответа "data": [{ 
 "itemtype": "Напитки", 
 "items": [
 { 
 "name": "Маргарита", 
 "price": "15,95$" 
 } 
 ] 
 }, 
 " itemtype": "Еда", 
 { "items": [ 
 { 
 "name": "Картофель фри", 
 "price": "10,9$5", 
 "аромат": "Соленый" 
 }, 
 { 
 "название": "Начос", 
 "цена": "12,45 $", 
 "вкус": "острый" 
 } 
 ] 
 } 
 ] 
 } 

PM — Это здорово. Но почему нет тела запроса?

Engineer — Правила, мой мальчик! Параметры запроса ‘, которые не что иное, как тело запроса, помещенное в URL.

PM — Спасибо, товарищ за объяснение. Не хотите ли заказать ужин, а затем идти домой, когда мы закончим объяснять API?

Инженер — Друг мой, мы едва коснулись поверхности. Позвольте мне углубиться в концепции API.

Мы немного поговорили о звонке Get. Но есть и другие методы, для которых я бы описал сценарий и аналог API:

b. Метод = Сообщение :

В воображаемом ресторане «Яхт-клуб» вы не нашли ни одной еды по своему вкусу. Вы звоните шеф-повару/владельцу ресторана и заказываете индивидуальное или новое блюдо. Скромный повар спрашивает, что бы вы хотели? Вы начинаете описывать свой знаменитый рецепт «Веганского бургера», который приготовила для вас ваша мама. Шеф-повар делает веганский бургер и подает его вам. Запах бургера настолько манящий, что вызывает любопытство у соседних столиков! Звонят повару и просят подать такое же блюдо.

Шеф-повар решает добавить в меню этот новый пункт!

В этом сценарии действие добавления нового элемента в меню называется « Post ». Как добиться этого, вежливо попросив об этом!

Запрос: Шеф-повар добавит новое блюдо под названием «Веганский бургер». Запрос должен содержать название позиции вместе с описанием и ценой, которые будут размещены в меню.

Ответ: Результатом будет подтверждение того, что «Веганский бургер», а также «Описание» и «Цена» размещены и видны в меню.

  Конечная точка:  http://theimaginaryyachtclubrestaurant.com/NewDish/ 
  Метод: Сообщение  
  Тело запроса:  { 
 'Content-Type': application/json' 
 'Accept': application/json' 
 'Accept': application/json' 'Data': { 
 'itemtype': 'Еда', 
 'название': 'веганский бургер', 
 'цена': '18,50$', 
 'вкус': 'острый' 
 } 
 } 
  Тело ответа :  
 HTTP/1.1 200 OK 
 Content-Type: application/jsonrequest 

PM — Хорошо, что в этом примере делают тип контента и Джейсон Стэтхэм?

Инженер — Тип контента является частью заголовка. Прежде чем вы спросите меня, что такое заголовок, он определяет метаданные информации о запросе и ответе. В этом примере заголовок содержит «Content-Type» и «Accept», которые говорят нам, каким должен быть формат данных запроса и ответа. Джейсон Стэтхэм на вашем языке или «JSON» в технических терминах — это один из типов формата данных, который означает, как будет выглядеть контент!

в. Метод = Введите

«Веганский бургер» пользуется большим успехом в ресторане, но клиенты жалуются на непомерную цену. Скромный повар / владелец решает снизить цену на несколько долларов.

В этом сценарии действие по обновлению существующего элемента в меню называется « Поместить ».

Запрос: Шеф-повар вводит новую цену на блюдо «Веганский бургер». Полезные данные запроса должны содержать ссылку на обновляемый элемент и параметры, требующие обновления, а также значения.

Ответ: В результате вы увидите обновленную цену в меню «Веганский бургер».

  Конечная точка:  http://theimaginaryyachtclubrestaurant.com/Menu/ 
  Метод: Put  
  Тело запроса:  
 { 
 'Content-Type': application/json' 
 'Accept': application/json' 
 'Accept 
 'Данные': { 
 'тип товара': 'Еда', 
 'название': 'веганский бургер', 
 'цена': '10,50 долларов', 
 'вкус': 'острый' 
 } 
 } 
  Ответ Тело: 
  HTTP/1.1 200 OK 
 Content-Type: application/jsonrequest 

d. Метод = Удалить

Из-за большого спроса на «Веганский бургер» шеф-повар решает удалить пункт из меню.

Действие по удалению элемента называется « Удалить » в терминологии API

Запрос: Шеф-повар попросит удалить «Икру» из меню. Полезная нагрузка запроса должна содержать имя элемента среди других деталей, которые необходимо удалить из меню.

Ответ: Результатом будет подтверждение того, что «Caviar» больше не отображается в меню.

  Конечная точка:  http://theimaginaryyachtclubrestaurant.com/Menu/itemType=Food/name='caviar'  Метод:Удалить   Тело ответа: 
  HTTP/1.1 200 OK 
 Тип содержимого: application/j19request 
   PM   — Вау! Это было довольно сложно. Мне нравится тот факт, что API делает все, что вы от него хотите.
   Инженер   — Ха-ха! В твоих мечтах, дружище! API не всегда точны. Иногда они склонны ошибаться.
   PM   — Итак, как я узнаю, когда произошла ошибка, как она произошла и что мне нужно понять?
   Инженер   — Это подводит нас к нашей следующей концепции под названием « кодов ответов ».
  2xx :  означает, что ваш запрос был выполнен успешно.
  3xx :  Представьте, что вы подъезжаете к воображаемому ресторану «Яхт-клуб» и видите объявление, вывеску о том, что он переехал на новый адрес, и представитель отеля, сообщающий вам направление нового местоположения. В терминах API это означает, что запрос перенаправляется на другой URL-адрес.
  4xx:  Вы подъезжаете к ресторану и заказываете «Икру», но обнаруживаете, что в ресторане ее больше не подают! Это эквивалентно ошибкам Клиента (не авторизовано, запрещено, страница не найдена).
  5xx:  В этом случае вы жертва! Вы заказали веганский бургер, но очередь была длинной, а приготовление вашего блюда заняло много времени. Вы оставили ресто в полном гневе. В терминах API это означает, что служба недоступна или тайм-аут шлюза.
 Подробнее о кодах ответов можно узнать по ссылке — https://http.cat/
 В соавторстве с Mittal Ankit
  Этот пост опубликован на   www.productschool.com   сообщества 
 Знакомство с учителями / Первый класс 
  
 Поиск
 Государственное дошкольное учреждение
 Специальное дошкольное образование
 Переходный детский сад
 Детский сад
 Первый класс
 Второй класс
 Третий класс
 Четвертый класс
 Пятый класс
 Шестой класс
 Седьмой класс
 Восьмой класс
 Музыка и физкультура
   
 Понимание и сотрудничество: 
 Участвуйте в совместных беседах с разными партнерами на темы и тексты  для 1 класса  со сверстниками и взрослыми в малых и больших группах.
 Следуйте согласованным правилам обсуждения (например, внимательно слушайте других, говорите по одному на обсуждаемые темы и тексты).
 
 Используйте разговоры других в беседах, отвечая на комментарии других через несколько обменов.
 Задавайте вопросы, чтобы устранить путаницу в обсуждаемых темах и текстах.
 Задавайте и отвечайте на вопросы о ключевых деталях текста, прочитанного вслух, или информации, представленной устно или с помощью других средств.
 Задавайте и отвечайте на вопросы о том, что говорит говорящий, чтобы собрать дополнительную информацию или прояснить то, что не понятно.
 Представление знаний и идей: 
 Описывать людей, места, вещи и события с соответствующими подробностями, ясно выражая идеи и чувства.
 Добавляйте рисунки или другие визуальные изображения к описаниям, когда это уместно, чтобы прояснить идеи, мысли и чувства.
 Произносить полные предложения, когда это соответствует задаче и ситуации.
  
   
 Ключевые идеи и детали: 
 Задавайте и отвечайте на вопросы о ключевых деталях текста.
 Определите основную тему и перескажите основные детали текста.
 Опишите связь между двумя людьми, событиями, идеями или фрагментами информации в тексте.
 Ремесло и структура: 
 Задавайте вопросы и отвечайте на них, чтобы определить или прояснить значение слов и фраз в тексте.
 Знать и использовать различные функции текста (например, заголовки, оглавления, глоссарии, электронные меню, значки) для поиска ключевых фактов или информации в тексте.
 Различать информацию, представленную изображениями или другими иллюстрациями, и информацию, представленную словами в тексте.
 Интеграция знаний и идей: 
 Используйте иллюстрации и детали в тексте для описания основных идей.
 Определите причины, по которым автор приводит опорные точки в тексте. 
 Определите основные сходства и различия между двумя текстами на одну и ту же тему (например, в иллюстрациях, описаниях или процедурах).
 Диапазон чтения и уровень сложности текста: 
 С подсказками и поддержкой читать информационные тексты, соответствующие сложности для 1 класса.
 2022-2023
  
   
 Операции и алгебраическое мышление 
 Представлять и решать задачи на сложение и вычитание.
 Понимать и применять свойства операций и взаимосвязь между сложением и вычитанием.
 Сложение и вычитание в пределах 20.
 Работа с уравнениями сложения и вычитания.
 Числа и операции с основанием 10 
 Расширьте последовательность счета.
 Понять разрядное значение.
 Используйте понимание разрядности и свойства операций сложения и вычитания.
 Измерение и данные 
 Измерение длины косвенным путем и путем повторения единиц измерения длины.
  
 Скажи и напиши время.
 Представление и интерпретация данных.
 Геометрия 
 Разум с формами и их атрибутами.
 Математические практики 
 Разбираться в задачах и настойчиво решать их.
 Рассуждайте абстрактно и количественно.
 Придумывайте жизнеспособные аргументы и критикуйте рассуждения других.
 Модель с математикой.
 Стратегически используйте подходящие инструменты.
 Следите за точностью.
 Ищите и используйте структуру.
 Ищите и выражайте регулярность в повторяющихся рассуждениях.
   
 Ключевые идеи и детали: 
 Задавайте и отвечайте на вопросы о ключевых деталях текста.
 Перескажите истории, включая ключевые детали, и продемонстрируйте понимание их основной идеи или урока.
 
 Опишите персонажей, место действия и основные события истории, используя ключевые детали.
 Ремесло и структура: 
 Определите слова и фразы в рассказах или стихах, которые вызывают чувства или обращаются к чувствам.
 Объясните основные различия между книгами, рассказывающими истории, и книгами, дающими информацию, опираясь на широкое чтение различных типов текстов.
 Определите, кто рассказывает историю в различных местах текста.
 Интеграция знаний и идей: 
 Используйте иллюстрации и детали в рассказе для описания его персонажей, обстановки или событий.
 Сравните и сопоставьте приключения и переживания героев рассказов.
 Диапазон чтения и уровень сложности текста: 
 С подсказкой и поддержкой читать прозу и стихи соответствующей сложности для 1 класса.
   
 Принципы печати: 
  
 Продемонстрировать понимание организации и основных функций печати.
 Распознавать отличительные черты предложения (например, первое слово, использование заглавных букв, пунктуация в конце).
 Фонологическая осведомленность: 
 Демонстрация понимания произносимых слов, слогов и звуков (фонем).
 Различать долгие и краткие гласные в произносимых односложных словах.
 Произносить в устной форме односложные слова путем смешения звуков (фонем), в том числе сочетаний согласных
 Выделять и произносить начальные, срединные гласные и конечные звуки (фонемы) в разговорных односложных словах.
 Разделите произносимые односложные слова на их полную последовательность отдельных звуков (фонем).
 Акустика и распознавание слов: 
 Знать и применять фонетику и навыки анализа слов на уровне своего класса при расшифровке слов.
 
  Знать соответствия написания и звука для общих согласных орграфов.
 Расшифруйте правильно написанные односложные слова.
 Знать окончание -e и общепринятые гласные команды для представления долгих гласных звуков.
 Используйте знание того, что каждый слог должен иметь гласный звук, чтобы определить количество слогов в печатном слове.
 Расшифруйте двухсложные слова по основным шаблонам, разбив слова на слоги.
 Прочитайте слова с флективными окончаниями.
 Распознавать и читать слова с неправильным написанием, соответствующие классу.
 Беглость: 
 Читать с достаточной точностью и беглостью, чтобы поддерживать понимание.
 Целенаправленно и с пониманием читайте текст для своего класса.
 Устно читать текст для своего класса с точностью, соответствующей скоростью и выражением при последовательном чтении.
  
 Используйте контекст для подтверждения или самостоятельного исправления распознавания и понимания слов, перечитывая при необходимости.
   
 Типы и цели текста: 
 Пишите авторские статьи, в которых они представляют тему или называют книгу, о которой пишут, излагают свое мнение, аргументируют свое мнение и создают ощущение завершения.
 Пишите информативные/пояснительные тексты, в которых они называют тему, сообщают некоторые факты о теме и дают некоторый смысл закрытия.