Freigeben über

Erste Schritte mit der Microsoft Learn-Katalog-API mit curl und Visual Studio Code

  • Artikel

Dieser Artikel unterstützt Sie bei den ersten Schritten mit der Microsoft Learn-Katalog-API mit curl und Visual Studio Code. Wenn Sie nicht mit den Details der API oder den Anwendungsfällen dafür vertraut sind, empfehlen wir Ihnen, zuerst den Artikel Übersicht über die Katalog-API zu lesen.

Der allgemeine Prozess, den wir durchgehen werden, ist:

  1. Abfragen der Lernkatalog-API
  2. Überprüfen der ersten Antwort
  3. "Prättifizieren" der Antwort
  4. Konvertiere es in eine Kalkulationstabelle
  5. Ausprobieren weiterer Abfragen

Sobald Sie mit der Verwendung der Lernkatalog-API für Ihre eigenen Anforderungen beginnen, können Sie diese Schritte leicht ändern, für Ihr gewünschtes Toolset oder Ihre Anforderungen, aber im Allgemeinen ist der Prozess der Verwendung für alle Anwendungsfälle identisch.

Voraussetzungen

Um die Schritte in diesem Artikel auszuführen, benötigen Sie curl und Visual Studio Code, zwei beliebte, kostenlose Tools zum Abfragen von APIs.

  • Wenn Sie curl und Visual Studio Code bereits installiert haben, können Sie direkt zum Abschnitt "Abfrage der Learn Catalog API" springen.
  • Wenn sie nicht installiert sind, folgen Sie den Anweisungen in den folgenden Abschnitten.

Herunterladen und Einrichten von Curl

curl ist ein beliebtes, kostenloses, open-source-, Befehlszeilentool, das APIs abfragen kann.

  1. Wechseln Sie zur curl Download Page, und laden Sie das für Ihre Umgebung zutreffende Paket herunter. Wenn Sie sich nicht sicher sind, welche Sie auswählen sollen, verwenden Sie den Curl Download-Wizard.
  2. Installieren Sie die Anwendung, und folgen Sie den Anweisungen zum Konfigurieren. Für diesen Artikel oder für die Abfrage der Learn Catalog-API sind keine speziellen Einstellungen erforderlich.

Herunterladen und Einrichten von Visual Studio Code

Visual Studio Code ist ein kostenloser, leistungsstarker Code-Editor, der von Microsoft erstellt wurde.

  1. Wechseln Sie zur Visual Studio Code-Website, und laden Sie das für Ihre Umgebung zutreffende Paket herunter.
  2. Installieren Sie die Anwendung, und folgen Sie den Anweisungen zum Konfigurieren.

Abfragen der Lernkatalog-API

Da für die Verwendung der Learn Catalog-API keine Authentifizierung erforderlich ist, können Sie den API-Endpunkt über jede Befehlszeile abfragen, die curl-enabled ist. Für diese Übung verwenden wir das Terminal in Visual Studio Code.

  1. Öffnen Sie Visual Studio Code.
  2. Wählen Sie "Terminal" in der oberen Navigationsleiste aus.
  3. Wählen Sie "Neues Terminal" aus, um ein neues Befehlsterminal zu öffnen.
  4. Wählen Sie Ihr Terminal ihrer Wahl (Bash, CMD usw.) aus, und geben Sie den folgenden Befehl ein. Der folgende Befehl gibt an, dass curl verwendet werden soll, um den ungefilterten Learn Catalog-API-Endpunkt aufzurufen, und die Antwort in eine Datei namens „output.json“ im im Terminal definierten Speicherort (z. B. C:\Users\<username>) auszugeben.
curl https://learn.microsoft.com/api/catalog >> output.json
  1. Wenn die Anforderung erfolgreich war, sollten Informationen zur Gesamtgröße der Datei angezeigt werden, z. B. 13,1 M (die Größe kann je nach Größe der Antwort geändert werden). Wenn dies nicht erfolgreich war, sollten Sie eine Fehlermeldung erhalten.

Anmerkung

Sie sollten die output.json Datei löschen, nachdem Sie sie verwendet haben, oder benennen Sie sie um, damit sie anwendbarer ist. Wenn Sie die API erneut mit demselben Dateinamen abfragen, wird die Antwort innerhalb der vorhandenen Datei angefügt. Eine weitere Option besteht darin, die Datei während des anfänglichen Abfragebefehls eindeutiger zu benennen, z. B. "output-1212.json" oder "output-de-de-2022-12-12.json".

Überprüfen der ersten Antwort

Die erste Antwort befindet sich in JSON und wird "minimiert" sein, was bedeutet, dass bestimmte Leerzeichen, Zeilen und Registerkarten entfernt werden, um die Datei zu verkleinern.

  1. Wählen Sie in Visual Studio Code "Datei" aus.
  2. Wählen Sie "Datei öffnen" aus.
  3. Navigieren Sie zur Datei "output.json", die als Teil des vorherigen Abschnitts erstellt wurde.

Diese Minimierung ist eine Standardpraxis, und die Datei kann "prättifiziert" werden, um durch einen Befehl in Visual Studio Code besser lesbar zu sein, den wir im nächsten Abschnitt ausführen.

Antwort verschönern

  1. Wenn die Datei "output.json" in Visual Studio Code geöffnet ist, verwenden Sie Ctrl+Shift+I.

Der JSON-Code sollte aktualisiert werden, um in mehrere Zeilen aufzuteilen und in einem besser lesbaren Format zu sein. Informationen zu den verschiedenen Eigenschaften und Werten innerhalb der Antwort finden Sie im Referenzartikel des Learn Catalog API Entwicklerhandbuchs für das Datenwörterbuch.

Antwort in eine Tabelle umwandeln

Es gibt viele Personen, die die Learn Catalog-API für einzelne Aufgaben oder Überprüfungen verwenden, anstatt sie in ein System zu integrieren. In diesen Anwendungsfällen kann es hilfreich sein, die JSON-Antwort in ein CSV- oder Excel-Format zu konvertieren, um sie als Kalkulationstabelle anzuzeigen. Sie können jedes bevorzugte Konvertierungstool verwenden, aber hier können wir die Flatfile Json zum CSV-Konverterverwenden.

  1. Wechseln Sie zu: https://csvjson.com/json2csv.
  2. Laden Sie Ihre Ausgabedatei hoch.
  3. Wählen Sie "Konvertieren" aus.
  4. Wählen Sie "Herunterladen" aus.

Anmerkung

Seien Sie sehr vorsichtig beim Einsatz externer Onlinetools zur Datenkonvertierung und überlegen Sie, welche Daten Sie dort eingeben. Im Fall der Learn Catalog-API ist die Antwort öffentlich verfügbar und erfordert keine Authentifizierung, daher ist es ok, ein Onlinetool zu verwenden, um das Format zu konvertieren.

Ausprobieren weiterer Abfragen

Führen Sie die vorstehenden Schritte aus, um weitere Abfragen zu testen, z. B. die unten aufgeführten Abfragen. Zeigen Sie an, wie sich die Größe der Antwortdatei für jeden ändert, und den Unterschied in Objekten innerhalb.

Beschreibung Frage
Alle Elemente in der Learn Catalog-API https://learn.microsoft.com/api/catalog/
Alle spanischen Module https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Alle Module mit einer Beliebtheitsbewertung von 0,9 oder höher https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Alle Sicherheitsschulungs- und Zertifizierungsobjekte für Anfänger https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Alle erweiterten Barrierefreiheitsmodule mit einer Beliebtheitsbewertung über 0,5 und im letzten Monat aktualisiert https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Nächste Schritte

Es wird empfohlen, die unten aufgeführten Ressourcen zu überprüfen, um Sie bei Ihrer Entwicklungsreise zu unterstützen: