#3 Список всех клиентов ~ 10 мин

  1. Каждый раз, когда мы вызываем новый endpoint, нашей отправной точкой является Swagger.
  2. Возвращаемся на API Portal к нашей спецификации: REST API Bootcamp.
  3. Смотрим Swagger для endpoint, который может лучше всего выполнить наш запрос (получить список всех клиентов). Используйте метод HTTP, путь и краткое описание.
  4. /GET customers - List all Customers звучит как хороший выбор. Открываем.
  5. Прочтите подробное описание, чтобы понять, соответствует ли конечная точка вашим потребностям. Да, это так!
  6. Далее давайте обратим своё внимание на список параметров. В нашем случае нет обязательных параметров пути, запроса или тела.
  7. Мы готовы вызвать API. Откроем в браузере вкладку с Httpie.io, создадим пустой запрос. Повторите упражнение (#1), если успели забыть, как это сделать.

Вызов API

  1. Когда мы вызываем API, нам необходимо указать две основных составных части:
    • API Base path – базовый путь интерфейса: это URL который используется для обращения к API Gateway
    • Resource name – имя ресурса, который мы хотим вызвать
    • Обе этих части составляют ссылку для вызова API
    • Базовый путь можете найти на этой странице. Скопируйте и добавьте в Httpie.io
    • Имя ресурса можно найти в спецификации. В нашем случае это /customers. Скопируйте и добавьте к базовому пути в Httpie.io
    • Проверьте, правильный ли HTTP глагол (method) вы используете для вызова. Должен быть GET. Для выбора другого метода следует использовать другие эндпоинты
    • Подсказка! Когда копируете ссылки и ресурсы в Httpie.io, убедитесь, что в результате получились корректные URL
    • Избегайте использования двойных слешей:
      • WRONG: http://api-base-path//customers
      • RIGHT: http://api-base-path/customers
    • Избегайте также пропуска слеша:
      • WRONG: http://api-base-pathcustomers
      • RIGHT: http://api-base-path/customers
    • Выбирайте правильный HTTP метод:
      • WRONG: POST http://api-base-path/customers
      • RIGHT: GET http://api-base-path/customers
  2. Нажмите кнопку SEND в Httpie.io, чтобы инициировать вызов
  3. В нижней части Httpie.io представлены результаты запроса
  4. Проверьте код состояния HTTP — там должно быть написано «Status 200 OK» зелеными буквами
  5. Просмотрите выходные данные вызова и сравните их с файлом Swagger. Проверьте область «Responses» конечной точки GET /customers. Найдите описание кода ответа HTTP 200
  6. Нажмите «Schema» и откройте все свернутые поля. В схеме вы найдете подробное описание того, как интерпретировать поля вашего вызова REST. Например, вы можете видеть, что поле «id» закодировано в формате UUID, а поле «born» всегда представлено в формате ГГГГ-ММ-ДД

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