Ankündigung von Updates für die REST-API-Oberfläche

Dieser Beitrag wurde von Jessie Huang geschrieben. Sie ist Program Manager des docs.microsoft.com-Teams.

Wir freuen uns, Ihnen heute das Release zweier wichtiger Verbesserungen der REST-Benutzeroberfläche auf doc.microsoft.com bekanntgeben zu können:

  • Mit der Vorschauversion des REST-API-Browsers können Sie von Microsoft entwickelte REST-APIs ganz einfach suchen und entdecken.
  • REST Try It ist eine interaktive Benutzeroberfläche, mit der Sie REST-APIs direkt in Ihrem bevorzugten Webbrowser ausprobieren können.

Alle REST-APIs an einem Ort

Wenn Sie bereits mit einer unserer vorhandenen REST-API-Browseroberfläche vertraut sind, wie der für .NET, PowerShell, Python oder JavaScript, werden Sie sich mit diesem Release sofort zurechtfinden. Mit ihm können Sie die Dokumentation für eine Vielzahl von REST-APIs schnell abrufen, ohne dabei auf eine weniger präzise Suchfunktion zurückgreifen zu müssen. Mit dem API-Browser können Sie die richtige API in Sekundenschnelle finden.

Bisher mussten Sie die Suchfunktion für die gesamte Website oder eine der Navigationskomponenten der Inhaltsseiten (z. B. das Inhaltsverzeichnis) nutzen, wenn Sie eine bestimmte REST-API-Dokumentation auf docs.microsoft.com suchen mussten. Dies kann zeitaufwändig sein, insbesondere wenn Sie eigentlich genau wissen, wonach Sie suchen. Wir wollten diesen Prozess vereinfachen.

Ab heute können Sie REST-APIs von Microsoft von einer zentralen Anlaufstelle aus viel effizienter suchen: https://docs.microsoft.com/rest/api. Wählen Sie einfach einen Dienst aus der Dropdownliste aus, um nach allen verfügbaren Dienst-APIs zu suchen:

Discover REST APIs by selecting products

Möchten Sie Zeit sparen? Die am häufigsten verwendeten APIs können über Schnellfilter gefunden werden. Wenn Sie auf einen dieser Filter klicken, werden Ihnen sofort alle APIs für das neueste Release eines bestimmten Diensts angezeigt:

Discover REST APIs via in-page quick filter

Wir haben die Suchfunktion so entworfen, dass Sie die erforderlichen API-Informationen finden können. Dabei spielt es keine Rolle, ob Sie die genauen Schlüsselwörter kennen oder nicht – oder sogar, ob Sie den Dienst, in dem sie enthalten sind, nicht kennen. Standardmäßig werden alle auf docs.microsoft.com dokumentierten APIs durchsucht. Nur wenn ein Dienst ausgewählt wird, erfolgt die Suche nur nach APIs für diesen Dienst.

Searching REST APIs by a single keyword

Müssen Sie gleichzeitig nach mehreren Schlüsselwörtern suchen? Das ist kein Problem.

Searching REST APIs by multiple keywords

Testen von Azure-REST-APIs in Ihrem Browser

Sie haben eine interessante Azure-API gefunden, wissen aber nicht, ob sie für Ihr Szenario genau das Richtige ist? Das ist kein Problem: Ab heute können Sie Azure-REST-APIs direkt in Ihrem Browser auf docs.microsoft.com ausprobieren.

Sie müssen dazu lediglich die grüne Schaltfläche Ausprobieren anklicken:

REST Try It - Launching the experience

Wenn Sie Ausprobieren für eine REST-API auswählen, gelangen Sie zu einer fokussierten Ansicht, in der Sie mit unterschiedlichen Parameterwerten oder Anforderungstexten experimentieren können. Sie können den Artikelkontext genauso einfach über das Hamburger-Menü Inhalt oben links auf der Seite ändern:

REST Try It - Changing the article context

Wir freuen uns über Ihr Feedback!

Es gibt viele Verbesserungen, die wir schon bald implementieren möchten, daher ist diese Benutzeroberfläche auf keinen Fall endgültig. Beispielsweise möchten wir das die „Ausprobieren“-Funktion nicht nur für Azure-REST-APIs aktivieren. Teilen Sie uns mit, wie wir die REST-Benutzeroberfläche verbessern können.Fügen Sie dazu einfach einen neuen Issue hinzu. Dann werden wir Sie so bald wie möglich kontaktieren.

Sie können auch unserem Twitter-Konto folgen, um die neuesten Updates und Benachrichtigungen zu lesen!

Sie möchten Entwicklern ihre Arbeit erleichtern? Werden Sie Teil unseres Teams!