Объявление об обновлениях интерфейса REST API

Автор записи — Джесси Хуанг (Jessie Huang), руководитель программы в команде docs.microsoft.com.

Сегодня мы рады сообщить о выпуске двух ключевых улучшений для интерфейса REST на сайте docs.microsoft.com:

  • Предварительная версия обозревателя REST API предоставляет простой способ поиска и обнаружения интерфейсов REST API, разработанных корпорацией Майкрософт.
  • REST Try It — интерактивный интерфейс, позволяющий оценить работу интерфейсов REST API прямо в вашем любимом веб-браузере.

Поиск интерфейсов REST API в одном месте

Если вы уже знакомы с какими-либо существующими функциями обозревателя API, например предназначенными для .NET, PowerShell, Python или JavaScript, этот новый выпуск не вызовет у вас никаких затруднений и позволит быстро получить документацию для широкого спектра интерфейсов API, не полагаясь на возможности, которые не обеспечивают подобную полноту поиска. Обозреватель API поможет вам быстро получить доступ к нужному API за считаные секунды.

Ранее, если вы хотели найти документацию по конкретному REST API на сайте docs.microsoft.com, вам, возможно, приходилось искать ее с помощью функции поиска по всему сайту или использовать любой из компонентов навигации на страницах содержимого, например оглавление. Это может занимать много времени, особенно в ситуациях, когда точно известно, что именно вы ищете. Мы хотели сделать этот процесс проще.

Начиная с сегодняшнего дня, вы можете эффективнее обнаруживать интерфейсы REST API корпорации Майкрософт в одном централизованном расположении — https://docs.microsoft.com/rest/api. Просто выберите службу в раскрывающемся списке, чтобы найти все доступные интерфейсы API службы:

Discover REST APIs by selecting products

Хотите сэкономить щелчок? Для некоторых наиболее часто используемых интерфейсов API можно использовать Экспресс-фильтры. Щелкнув один из них, вы получите доступ к обширному набору интерфейсов API для заданной службы с учетом актуального выпуска:

Discover REST APIs via in-page quick filter

Мы разработали возможности поиска, позволяющие найти необходимые сведения об интерфейсах API, независимо от того, известны ли вам ключевые слова или даже служба, к которой относится интерфейс. По умолчанию мы будем выполнять поиск по всем интерфейсам API, задокументированным на сайте docs.microsoft.com. Если выбрана служба, поиск будет выполняться в рамках этой службы.

Searching REST APIs by a single keyword

Вам нужно осуществлять поиск по нескольким ключевым словам одновременно? Это тоже возможно!

Searching REST APIs by multiple keywords

Оценка интерфейсов REST API Azure в браузере

Вы нашли нужный интерфейс API Azure, но не знаете, подходит ли он для реализации вашего сценария? Не волнуйтесь, ведь теперь вы можете оценить интерфейсы REST API Azure прямо в браузере на сайте docs.microsoft.com.

Вам достаточно нажать зеленую кнопку Try It (Попробовать).

REST Try It - Launching the experience

Нажав кнопку Try It (Попробовать) для REST API, вы перейдете к фокусированному представлению, которое позволят экспериментировать с различными значениями параметров или текстом запроса. Так же легко можно изменить контекст статьи, используя меню "гамбургер" в левом верхнем углу страницы:

REST Try It - Changing the article context

Ждем ваших отзывов

Мы планируем реализовать множество улучшений в ближайшем будущем, поэтому этот интерфейс ни в коем случае не следует считать окончательным. Например, мы включим функцию "Try It" (Попробовать) не только для интерфейсов REST API Azure. Мы бы хотели, чтобы вы рассказали нам о том, как сделать интерфейс REST лучше. Просто создайте новый вопрос, и мы ответим вам максимально быстро.

Вы также можете подписаться на нашу учетную запись в Twitter и получать последние обновления и уведомления.

Хотите улучшить условия труда для разработчиков? Присоединяйтесь к нашей команде!