Добавление API вручную

Статья
06/01/2023

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

В этой статье приводятся действия по добавлению API вручную в экземпляр Управления API. Если требуется макетировать API, можно создать пустой API-интерфейс или определить его вручную. Сведения об имитации API см. в статье Mock API responses (Имитация ответов API).

Если вы хотите импортировать существующий API, изучите список связанных разделов.

В этой статье мы создадим пустой API и укажем httpbin.org (общедоступную службу тестирования) в качестве API серверной части.

Необходимые компоненты

Выполните задачи из краткого руководства по созданию экземпляра службы управления API Azure

Перейдите к экземпляру службы управления API.

На портале Azure найдите и выберите службы Управление API.
На странице Службы Управления API выберите экземпляр Управления API.

Создание API

На портале Azure перейдите к службе "Управление API" и в меню выберите Интерфейсы API.
Выберите + Add API (+ Добавить API) в меню слева.
Выберите HTTP из списка.
Укажите URL-адрес веб-службы серверной части (например, https://httpbin.org) и другие параметры API. Эти параметры описаны в руководстве Импорт и публикация первого интерфейса API.
Нажмите кнопку создания.

Сейчас в Управлении API нет операций, сопоставленных с операциями в API серверной части. Вызвав операцию, которая предоставляется в серверной части, но еще не сопоставлена с Управлением API, вы получите ответ 404.

Примечание.

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

Добавление и проверка операции

В этом разделе показано, как добавить операцию /get и сопоставить ее с операцией серверной части "http://httpbin.org/get"

Добавление операции

Выберите API, созданный на предыдущем шаге.
Щелкните + Add Operation (+ Добавить операцию).
В поле URL-адрес выберите значение GET и введите /get в качестве значения ресурса.
Введите FetchData в поле Отображаемое имя.
Выберите Сохранить.

Проверка операции

Проверка функции выполняется на портале Azure. Тестировать API можно также на портале разработчика.

Откройте вкладку Тест.
Выберите FetchData.
Нажмите кнопку Отправить.

Появится сообщение с ответом, который создает операция "http://httpbin.org/get" Если вы хотите преобразовать операцию, используйте инструкции из статьи Transform and protect your API (Преобразование и защита API).

Добавление и проверка параметризованной операции

В этом разделе показано, как добавить операцию, которая принимает параметр. Здесь мы сопоставим операцию с адресом "http://httpbin.org/status/200"

Добавление операции

Выберите API, созданный на предыдущем шаге.
Щелкните + Add Operation (+ Добавить операцию).
В поле URL-адрес выберите значение GET и введите /status/{code} в качестве значения ресурса. Здесь же можно указать полезные сведения об этом параметре. Например, укажите значение номер в поле тип и число 200 (по умолчанию) в поле значения.
Введите отображаемое имя GetStatus.
Выберите Сохранить.

Проверка операции

Проверка функции выполняется на портале Azure. Тестировать API можно также на портале разработчика.

Откройте вкладку Тест.
Выберите GetStatus. По умолчанию устанавливается значение кода 200. Его можно изменить, чтобы проверить работу других значений. Например, введите значение 418.
Нажмите кнопку Отправить.

Появится сообщение с ответом, который создает операция "http://httpbin.org/status/200" Если вы хотите преобразовать операцию, используйте инструкции из статьи Transform and protect your API (Преобразование и защита API).

Добавление и проверка операции с подстановочным знаком

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

Внимание

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

Добавление операции

Выберите API, созданный на предыдущем шаге.
Щелкните + Add Operation (+ Добавить операцию).
В поле URL-адрес выберите значение GET и введите /* в качестве значения ресурса.
В качестве отображаемого имени введите WildcardGet.
Выберите Сохранить.

Проверка операции

Проверка функции выполняется на портале Azure. Тестировать API можно также на портале разработчика.

Откройте вкладку Тест.
Выберите WildcardGet. Попробуйте выполнить операции GET, протестированные в предыдущих разделах, или воспользуйтесь другой поддерживаемой операцией GET.

Например, в параметрах шаблона измените значение для подстановочного знака (*) на headers. Операция возвращает HTTP-заголовки входящего запроса.
Нажмите кнопку Отправить.

Появится сообщение с ответом, который создает операция "http://httpbin.org/headers" Если вы хотите преобразовать операцию, используйте инструкции из статьи Transform and protect your API (Преобразование и защита API).

Примечание.

Важно понимать, как узел для API серверной части, с которым выполняется интеграция, обрабатывает символы косой черты в URL-адресе операции. Дополнительные сведения см. в статье Вопросы и ответы об Управлении API.