API-Dokumentation anzeigen

Wenn Sie mit der externen API in Totara arbeiten, sollten Sie ein API-Referenzhandbuch sehen, das alle in der API verfügbaren Dienste und deren Verwendung beschreibt. Totara verfügt über eine integrierte Referenzdokumentation, die aus dem GraphQL-Schema generiert wurde. Diese Dokumentation spiegelt die API-Funktionen wider, die für die spezifische Version von Totara verfügbar sind, auf der die Website läuft, und umfasst Dienste, die durch Codeanpassungen von Drittanbietern hinzugefügt oder geändert werden.

Beachten Sie, dass die API-Dokumentation die offizielle Totara-Version widerspiegelt, die die Website verwendet. Wenn Sie Codeanpassungen vornehmen und möchten, dass deren API-Dienste in der API-Dokumentation angezeigt werden, müssen Sie sie neu erstellen , damit diese Änderungen auf dieser Seite angezeigt werden. Wenn die aktuelle Dokumentation veraltet ist, zeigt die API-Dokumentationsseite eine Warnung an, die dies anzeigt.

Nur Nutzer mit der Funktion totara/api:viewdocumentation können auf die API-Dokumentation zugreifen. Standardmäßig umfasst dies Site-Administratoren, Site-Manager und Mandanten-Domain-Manager.

So zeigen Sie die Dokumentation an:

Navigieren Sie zum Schnellzugriffsmenü > API>>-Dokumentation Entwicklung.
Verwenden Sie das Inhaltsverzeichnis in der linken Spalte, um zu einem bestimmten Abschnitt zu springen.
Klicken Sie auf Zurück zur API , um zur Liste der API-Clients zurückzukehren.

Auf dieser Seite sehen Sie die folgenden Informationen zur API:

Endpunkt-Details
Authentifizierung
Format anfordern
Link zum API-Schema
Verfügbare Abfragen und Mutationen
Verfügbare Typen

Die Dokumentationsseite enthält Beispiele für das Format sowohl der spezifischen Anfrage als auch der Antwort, die von der API zurückgegeben wird.

Anzeigen der API-Dokumentation in Totara.

Join the Totara Community for more resources to help you get the most out of Totara.