GraphQL UI ist eine leistungsstarke webbasierte Schnittstelle (Banana Cake Pop, Nitro) zur Erforschung und Interaktion mit GraphQL-APIs. Sie ermöglicht es Nutzern, Schemata zu durchsuchen, Abfragen zu schreiben und diese live zu testen – alles in einer sauberen, für Entwicklerfreundliche Umgebung.

GraphQL-Benutzeroberflächen-URLs

Die GraphQL-Benutzeroberfläche für jede Umgebung ist hier verfügbar:

https://api.xoap.io/graphql/ui

Ein neues Dokument erstellen

Sobald die GraphQL-Benutzeroberfläche geladen ist, klicken Sie auf “Dokument erstellen” Klicken Sie auf die Schaltfläche, um zu beginnen.

Hinweis: Wenn Ihr Browser Pop-ups blockiert, sollten Sie diese bei Bedarf dennoch erlauben.

Authentifizierung konfigurieren

Bevor Sie die API abfragen können, müssen Sie Ihre Sitzung authentifizieren.

Einstellungen öffnen

Klick auf den Einstellungen Ein Symbol in der rechten oberen Ecke, mit dem Sie die Verbindung konfigurieren können. Hier legen Sie sowohl den Endpunkt als auch die OAuth2-Authentifizierungsdaten fest.

HTTP-Endpunkt

Unter der “HTTP-Endpunkt” Im Abschnitt „Verwenden Sie eine andere URL“ geben Sie die korrekte URL für Ihre Umgebung ein:

https://api.xoap.io/graphql

Autorisierungseinrichtung (OAuth2)

Unter der “Autorisierung” In der Sektion „Konfiguration“ können Sie die folgenden Einstellungen vornehmen:

Feld	Wert
Typ	OAuth 2
Stipendienart	Autorisationscode
Autorisations-URL	https://auth.xoap.io/auth/realms/my.xoap.io/protocol/openid-connect/auth
URL für den Zugriffstoken	https://auth.xoap.io/auth/realms/my.xoap.io/protocol/openid-connect/token
Kunden-ID	GraphQL
Verwenden Sie PKCE	Ja
Code Challenge-Methode	SHA-256
URL-Weiterleitung	https://api.xoap.io/graphql/ui/
Umfänge	E-Mail-Profilrollen – Herkunft im Web
Qualifikationen	Als Basic Auth Header (Standard)

Authentifizieren und anwenden

1. Klick auf den Fetch Taste.
2. Sie werden zur Login-Seite von XOAP.
3. Geben Sie Ihre Anmeldedaten ein.
4. Sobald die Authentifizierung abgeschlossen ist, werden Sie zurück zur GraphQL-Benutzeroberfläche weitergeleitet.
5. Klicken Sie auf “Anwenden” Um den Token zu bestätigen — er wird zu Ihren Anforderungshintergründen hinzugefügt.

Leitfaden für die Anforderung von Daten an einen neuen Benutzer

Wie bei Swagger erfordert die API eine Mieter-ID in den Kopfzeilen zu übermitteln.

In einem nächsten Schritt erklären wir Ihnen, wie Sie diesen Header einrichten.

Hinzufügen des Tenant-Headers

Um Ihre API-Anrufe akzeptiert zu erhalten, müssen Sie eine gültige Mieter-ID in den Anforderungshintergründen.

Dieser Schritt ist erforderlich – unsere API verwendet den Tenant-Header, um den Workspace zu identifizieren, der den Anforderung sendet. Die Tenant-ID (in einigen Fällen auch als Workspace-ID bezeichnet) kann aus app.xoap.io  Instrumentenbrett wie hier dargestellt:

Um dies zu tun:

1. Scrollen Sie bis zum Untere linke Ecke HTTP-Header im GraphQL-Benutzeroberflächenbereich (unterhalb des Abschnitts „Authentifizierungstoken“).
2. Klicken Sie auf “Header”.
3. Geben Sie die folgenden Werte ein:

• NameMietvertrag
• Wert: Ihre Mieternummer

Dieser Header ist erforderlich, damit alle authentifizierten Anfragen gültig sind.

Nachdem sie hinzugefügt wurden, wird der Tenant-Header in alle zukünftigen GraphQL-Anfragen aufgenommen, die aus der Benutzeroberfläche gesendet werden.

Schema laden

Sobald die Authentifizierung abgeschlossen und die Header festgelegt sind, müssen Sie Schema laden Damit kann die Benutzeroberfläche Anweisungen zur Abfrage und automatische Vervollständigung bereitstellen.

Dies können Sie entweder tun:

• Drücken Sie Ctrl + Alt + R
• Beim Klicken auf Schema neu laden Button in der Benutzeroberfläche

Dies wird den vollständigen Schema aus dem Server abrufen und Funktionen wie Feldvorschläge, Typinformationen und Validierung ermöglichen.

Nachdem das Schema geladen wurde, versuchen Sie, eine Abfrage einzugeben – die Benutzeroberfläche bietet Ihnen Intelligenz-ähnliche Vorschläge basierend auf den verfügbaren Typen und Feldern.

Eine Testabfrage ausführen

Jetzt sind Sie bereit, GraphQL-Abfragen zu schreiben und auszuführen.

• Verwenden Sie das Editor-Panel, um Ihre Suchanfrage einzugeben.
• Klick auf den ausführen. () -Button oder drücken Sie Ctrl + Enter, um die Aktion auszuführen.
• Die Antwort wird im rechten Bedienfeld angezeigt.

Dies ist eine großartige Möglichkeit, um:

• Erkunden Sie die API, ohne dass Sie Zugriff auf die Frontend-Komponenten benötigen
• Schnell benutzerdefinierte Abfragen testen oder Probleme beheben
• Arbeitsabfragen in eigene Skripten oder Tools kopieren

Sie haben nun die Einrichtung abgeschlossen und die XOAP GraphQL-API erfolgreich getestet.

Optional: Sie können dies nun mit Swagger UI für vollständige Unterstützung von REST + GraphQL in Ihrer Entwicklung oder Automatisierungsumgebung.

The post GraphQL UI appeared first on XOAP.

Swagger UI ist ein interaktives Dokumentationswerkzeug für REST-APIs. Es ermöglicht Benutzern, verfügbare Endpunkte zu erkunden, benötigte Parameter anzuzeigen und API-Anrufe direkt aus dem Browser auszuführen – ohne Code zu schreiben.
Wofür wird es verwendet?

• Veranschaulichen der verfügbaren API-Endpunkte und deren Anforderung/Antwortstrukturen
• Erfahren Sie, wie Sie die API anrufen (z. B. erforderliche Header, Anfrageparameter)
• Testpunkte in Echtzeit mit tatsächlichen Daten testen
• Erstellen von automatisch generierten Curl- und Anforderungsvorlagen

Warum ist es nützlich?

• Keine Front-End-Anwendung erforderlich: Backend-Entwickler, QA-Ingenieure oder Integrationspartner können APIs testen, selbst wenn die Front-End-Anwendung noch nicht verfügbar ist.
• Skriptkompatibel: Sie können eine API-Anrufung in Swagger testen und dann denselben Anforderungstyp in Tools wie Postman, curl oder Skripten (z. B. Python, PowerShell) verwenden.

Swagger-URLs

Sie können die Swagger-Benutzeroberfläche unter dem folgenden Link aufrufen:
https://api.xoap.io/swagger/index.html

Authentifizierung in Swagger UI

Sobald Sie auf der Swagger-Benutzeroberflächenseite sind, führen Sie die folgenden Schritte aus, um sich zu authentifizieren und Zugriff auf geschützte Endpunkte zu erhalten.

Wählen Sie den API-Server aus

An der Spitze der Swagger-Benutzeroberfläche befindet sich ein Dropdown-Menü, über das der API-Server ausgewählt werden kann.
Wählen Sie die Option, die normalerweise mit dem Label „XOAP API SSL“ gekennzeichnet ist.

Klick auf den Autorisieren Die Schaltfläche befindet sich in der oberen rechten Ecke der Seite. Dadurch wird ein Pop-up-Fenster geöffnet, das zwei Abschnitte enthält:

• OAuth2-Autorisierung
• Leihantrag (apiKey)-Header

Unter der OAuth2 Abschnitt:

1. Klicken Sie auf die Schaltfläche „Autorisieren“.
2. Sie werden zur Login-Seite von XOAP.
3. Geben Sie Ihre Benutzernamen und Passwort.
4. Nach erfolgreichem Login werden Sie wieder zu Swagger weitergeleitet und die Autorisationsheader Sie werden automatisch in alle Anfragen aufgenommen.

Unterhalb des Abschnitts „OAuth2“ befindet sich ein Feld zum Festlegen des Tenant-Headers:

• Fügen Sie Ihre Mieter-ID In das Eingabefeld.
• Klick auf den Autorisieren Button nebenher.

Dieser Schritt ist erforderlich – unsere API verwendet den Tenant-Header, um den Workspace zu identifizieren, der den Anforderung sendet. Die Tenant-ID (in einigen Fällen auch als Workspace-ID bezeichnet) kann aus app.xoap.io  Instrumentenbrett wie hier dargestellt:

Sobald beide Genehmigungen vorliegen:

• Die Benutzeroberfläche wird angezeigt grüne Kontrollmarken.
• Sie können jetzt Klicken Sie auf “Schließen” Im Autorisierungsdialog.
• Alle Ihre Anfragen werden nun die korrekten Authorization- und Tenant-Header enthalten.

Sie sind nun bereit, die authentifizierte API in Swagger zu verwenden!

Testen eines API-Endpunkts

Sobald Sie authentifiziert sind, können Sie mit der Erforschung und dem Testen der API beginnen. Finden Sie in der Liste (z. B. unter einem Tag wie „Geräte“, „Benutzer“ usw.) eine verfügbare Endpunkt und erweitern Sie ihn, und klicken Sie dann auf „Weiter“. “Versuchen Sie es” Button. Nachdem Sie alle erforderlichen Parameter (Pfad, Abfrage oder Body) eingegeben haben, klicken Sie auf “Ausführen”.

Swagger zeigt sowohl die Anfrage gesendet und das Antwort Erhalten von dem Server.

Was Sie sehen werden:

• Die vollständige Anforderungsserveradresse
• Header (einschließlich Authorization und Tenant)
• Anforderungsgrundlage (falls zutreffend)
• HTTP-Status der Antwort (z. B. 200 OK, 401 Unauthorized)
• JSON-Ansprücheinhalt aus der API

Dies ist eine hervorragende Möglichkeit, zu überprüfen, ob Ihre Berechtigungen funktionieren, und um die Struktur von Anfragen und Antworten zu verstehen, bevor Sie sie in ein Skript oder eine Anwendung integrieren.

Jetzt, wo Sie die REST-API in der Swagger-Benutzeroberfläche getestet haben, können Sie diese Anrufe in Ihre eigenen Tools und Workflows integrieren – sei es über Postman, curl oder benutzerdefinierte Skripts.

Dies ermöglicht es fortgeschrittenen Anwendern, experimentieren, testen und eigene Automatisierungs- oder Integrationsskripts mithilfe der beiden API-Stile zu erstellen, je nach Bedarf.

The post API access documentation (Swagger) appeared first on XOAP.

Erhalten Sie eine Liste aller auf Ihren Nodes installierten Anwendungen

Die folgende GraphQL-Abfrage liefert eine Liste aller Anwendungen installiert auf allen Knotenpunkten (Systemen) in Ihrer Umgebung:

query NodesWithSoftware($skip: Int = 0, $take: Int = 500) {
  configMngt_Nodes(skip: $skip, take: $take) {
    totalCount
    pageInfo { hasNextPage }
    items {
      id
      nodeName
      lastSystem {
        software {
          displayName
          displayVersion
          publisher
        }
      }
    }
  }}

Hinweise:
• Wenn Sie mehr als 500 Knoten verwalten, erhöhen Sie den Wert der $nehmen Demnach.
• Die Pagination wird unterstützt mit Skip und hasNextPage.

Erhalten Sie eine Liste aller Anwendungen, die im XOAP- Application Management Modul verfügbar sind

Das ist nützlich für Berichterstattung, Validierung, oder Automatisierungsaufgaben, die Anwendungserklärungen. Hierfür können Sie die folgende GraphQL-Abfrage verwenden:

Abfrage ListAllApplications($Skip: Int = 0, $Take: Int = 100)
  appMngt_Applications(skip: $skip, take: $take) {
    totalCount
    pageInfo { hat die nächste Seite }
    Artikel {
      id
      Name
      Lieferant
      Version
      PackageName
      Operating System
      Architektur
      Sprache
      createdAt
      Updated am
    }
  }
}

Diese Abfrage gibt außerdem die Metadaten für alle Anwendungen, einschließlich Details wie Anbieter, Version, Ziel-Betriebssystem und Architektur.

Hinweise:
• Sie können die $nehmen Wert, falls mehr als 100 Anträge erwartet werden.
• Verwenden Sie die hasNextPage Wenn nötig, kann die Seite eine Seitenumbrüche implementieren.

Erhalten Sie eine Liste aller Systeme eines bestimmten Hardwareherstellers

Mit dieser Anforderung können Sie alle Knoten eines bestimmten Herstellers abrufen (z. B. Lenovo) wurde in Ihrem XOAP-Arbeitsbereich registriert.

Das kann nützlich sein für Bestandsprüfungen, Management des Hardware-Lebenszyklus, oder verkäuferbezogene Patch- und Compliance-Aktivitäten. Verwenden Sie die folgende GraphQL-Abfrage:

query LenovoFlatNodes($skip: Int = 0, $take: Int = 5) {
  configMngt_FlatNodes(
    skip: $skip
    take: $take
    where: { csManufacturer: { eq: "LENOVO" } }
    order: [{ nodeName: ASC }]
  ) {
    totalCount
    pageInfo { hasNextPage }
    items {
      id
      nodeName
      csManufacturer
      csModel
      osName
      osVersion
    }
  }
}

Hinweise:
• Der Name des Herstellers ist spaltengetreue Zeichen.
• Um nach einem anderen Anbieter (z. B. HP, DELL) zu filtern, ändern Sie den Wert der Option csManufacturer: { eq: "..." } Demnach.
• Erhöhen Sie die $nehmen value, um weitere Datensätze abzurufen oder die Seitenumbrüche mithilfe des hasNextPage feld.
• Dieses Beispiel sortiert die Ergebnisse nach nodeName in aufsteigender Reihenfolge.

Wie Sie wissen, was Sie abfragen können

XOAP sammelt eine große Menge an Daten von Ihren Knoten sowie zusätzliche Metadaten aus Ihrem Arbeitsbereich. Mit einer solchen großen Datenmenge kann es schwierig sein zu bestimmen, welche Felder für die Abfrage verfügbar sind.

Die effektivste Methode zur Erkundung der verfügbaren Abfrageoptionen besteht darin, die SDL (Schema Definition Language). Das SDL bietet eine vollständige Übersicht über alle Objekte, Felder und Typen, die über GraphQL abfragbar sind.

Durch die Inspektion des SDL können Sie Folgendes tun:

• Entdecken Sie alle verfügbaren Datenstrukturen
• Identifizierung von Beziehungen zwischen Entitäten
• Erfahren Sie mehr über das vollständige Potenzial von GraphQL-Abfragen in XOAP

Dieser Ansatz sorgt dafür, dass Sie nicht von vordefinierten Abfragen eingeschränkt werden und die in Ihrer Umgebung gesammelten Daten voll nutzen können.

Sie benötigen weitere Anfragen oder möchten Ihre eigenen hinzufügen?

Die github.com/xoap-io/queries Das Repository ist Ihr Die beliebte Sammlung wiederverwendbarer GraphQL-Abfragen geeignet für die Hardware- und Anwendungsverwaltung innerhalb von XOAP und verwandten Plattformen.

So verwenden Sie es:

1. Navigieren Sie zu der Anwendungen/ oder Hardware/ Ordner.
2. Kopieren Sie die entsprechenden Daten .graphql Fügen Sie die Datei in Ihren API- oder GraphQL-Client ein.
3. Passen Sie die Parameter nach Bedarf an Ihre Umgebung an.

Nach der MIT-Lizenz und mit bisher null Sternen oder Forks blüht dieses Projekt weiter. Wir begrüßen Ihre Beiträge sehr – sei es durch das Einreichen von Problemen, die Verbesserung von Abfragen oder die Eröffnung von Pull-Requests, um diese gemeinsame Ressource zu erweitern. Lassen Sie uns gemeinsam wachsen!

The post What you can do with GraphQL appeared first on XOAP.