Обнаружение и потребление API

  • 5 мин

Обнаружение и потребление API являются важной частью использования API в организации.

В этом уроке вы узнаете, как расширение VS Code Центра API позволяет легко обнаруживать и использовать API.

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

Чтобы управлять API с помощью расширения Центра API в VS Code, вам потребуется:

Следующие расширения Visual Studio Code являются необязательными и необходимы только для определенных сценариев, как указано ниже.

  • Расширение клиента REST — для отправки HTTP-запросов и просмотра ответов в Visual Studio Code напрямую.
  • Расширение Microsoft Kiota — для создания клиентов API.

Обнаружение и потребление API

Вы можете просматривать каталог API вашей организации непосредственно в Visual Studio Code со всеми api-интерфейсами, версиями, определениями, средами и развертываниями. С одним взглядом вы мгновенно получите обзор всех API, доступных в вашей организации.

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

Снимок экрана: параметр API поиска в vs code

Просмотр документации по API

Вы также можете быстро получить доступ, предварительную версию документации по API и тестовые конечные точки для API в VS Code. Снимок экрана: документация swagger по vs code

  1. Откройте расширение Центра API на вкладке.
  2. Разверните представление дерева Центра API, чтобы отобразить определение API.
  3. Щелкните правой кнопкой мыши определение и выберите "Открыть документацию по API".
  4. Откроется новая вкладка с пользовательским интерфейсом Swagger для определения API.
  5. Выберите конечную точку и выберите "Попробовать", укажите необходимые параметры и нажмите кнопку "Выполнить".

Попробуйте ИСПОЛЬЗОВАТЬ API

С расширением Центра API можно просмотреть HTTP-файл на основе определения API, предоставленного в Центре API. В этом файле вы можете напрямую отправлять http-запросы и просматривать ответы прямо в редакторе.

Примечание.

Чтобы использовать эту возможность, необходимо установить расширение клиента REST. Снимок экрана: использование клиента REST для просмотра HTTP API в VS Code

  1. Разверните представление дерева Центра API, чтобы отобразить определение API.
  2. Щелкните правой кнопкой мыши определение и выберите "Создать HTTP-файл".
  3. Откроется новая вкладка, которая отображает http-документ, заполненный спецификацией API.
  4. Чтобы выполнить запрос, выберите конечную точку и выберите команду "Отправить запрос".

Создание пакетов SDK

Расширение Центра API также использует Microsoft Kiota для создания клиента для REST API HTTP для выбранного языка, как определено в спецификации OpenAPI. Это позволяет мгновенно создавать клиенты для всех или выбранных конечных точек для API, удовлетворяющих вашим бизнес-потребностям.

Примечание.

Чтобы использовать эту возможность, необходимо установить расширение Microsoft Kiota.

  1. Разверните представление дерева Центра API, чтобы отобразить определение API.

  2. Щелкните правой кнопкой мыши определение и выберите "Создать клиент API". Откроется панель генератора OpenAPI Kiota. Снимок экрана: выбор параметра для создания клиента API в vs code с помощью kiota

  3. Выберите конечные точки API и операции HTTP, которые необходимо включить в пакеты SDK. Вы можете навести указатель мыши на конечную точку и нажать кнопку "+", чтобы добавить ее или "-", чтобы удалить ее.

  4. После этого нажмите кнопку "Воспроизвести", чтобы создать клиент API. Снимок экрана: выбор параметра для добавления или удаления определенных конечных точек в vs code с помощью kiota

  5. Выберите " Создать клиент API".

    a. Введите сведения о конфигурации имени пакета SDK, пространства имен и выходного каталога.

    b. Выберите язык для созданного пакета SDK.

Портал Центра API с локальным размещением

Портал Центра API — это веб-сайт для разработчиков и заинтересованных лиц, чтобы легко обнаруживать и взаимодействовать с API в инвентаризации API. С помощью этого локального веб-сайта организации предоставляют пользователям возможности обнаружения и потребления веб-API.

Снимок экрана: целевая страница портала или веб-сайта центра api contoso

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

Примечание.

Приведенные ниже инструкции предназначены для развертывания в Статические веб-приложения Azure, но вы можете развернуть в выбранной инфраструктуре.

  1. Вилку кода реализации в Центре API.

  2. Создайте ресурс статического веб-приложения в Azure.

  3. В разделе "Сведения о развертывании" выберите GitHub в качестве источника и перейдите в репозиторий, содержащий начальный код Центра API.

  4. Статические веб-приложения обнаружит предустановки сборки и заполняет их React.

  5. Введите / в качестве расположения приложения.

  6. Введите dist в качестве расположения вывода.

  7. Нажмите кнопку создания.

    Снимок экрана: настройка для Статические веб-приложения Azure

Для просмотра кода, опубликованного на веб-сайте, может потребоваться до 5 минут.

Чтобы просмотреть портал Центра API, работающий на Статические веб-приложения, выберите "Просмотреть приложение в браузере" на вкладке "Обзор" в ресурсе статического веб-приложения, созданном в портал Azure.

Снимок экрана: развернутый веб-портал

Настройка управления доступом на основе ролей

Администраторы имеют полный контроль над назначением разрешений на доступ к API и ресурсам в Центре API организации с помощью управления доступом на основе ролей.

Примечание.

По умолчанию администраторы центра API не имеют доступа к API на портале Центра API. Обязательно назначьте роль читателя данных Центра API Azure для себя и других администраторов.

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