REST-Debugger (Tool)
Nach oben zu REST-Debugger
Tools > REST-Debugger
Der REST-Debugger ist ein Tool für die Erstellung von Ad-hoc-Anforderungen. Die Komponenten TRESTDataSetAdapter und TClientDataSet konvertieren die JSON-Repräsentation in eine Datenmenge.
Mit diesem Tool können Sie verschiedene Authentifizierungsmethoden zum Verbinden mit Diensten, wie z. B. Google API oder Twitter, verwenden. Sie können eine Anforderung an den angegebenen Dienst senden und die Antwort anzeigen.
Inhaltsverzeichnis
Der Anforderungsbereich
Anforderung
Auf der Registerkarte Anforderung geben Sie die Eigenschaften von TRESTClient und TRESTRequest an.
Element | Beschreibung |
---|---|
Methode |
Listet die TRESTRequest-Methoden wie folgt auf: |
URL |
Legt die Eigenschaft BaseURL der TRESTClient-Instanz fest. Die Eigenschaft BaseURL ist die erste Hälfte des vollständigen Anforderungs-URL.
|
Inhaltstyp |
Legt die Eigenschaft ContentType der TRESTRequestParameterList-Instanz fest. |
Benutzerdefinierter Rumpf |
Legt die Eigenschaft CustomBody der TRESTRequestParameterList-Instanz fest. |
Parameter
Auf der Registerkarte Parameter legen Sie die eigentliche Aktion, die für den Dienst ausgeführt werden soll, und die TRESTRequest-Parameter fest.
Element | Beschreibung |
---|---|
Ressource |
Legt die Eigenschaft Resource der TRESTRequest-Instanz fest. |
Anforderungsparameter |
Legt die TRESTRequest-Parameter fest. Es gibt verschiedene Parametertypen: |
Hinzufügen |
Fügt der TRESTRequest-Parameterliste einen neuen Parameter hinzu. Geben Sie den Parametertyp im Kombinationsfeld (TComboBox) Typ, den Parameternamen im Kombinationseingabefeld (TComboEdit) Name und den Parameterwert im Eingabefeld (TEdit) Wert an. |
Bearbeiten |
Bearbeitet einen Parameter aus der TRESTRequest-Parameterliste. Ändern Sie den Typ, den Namen oder den Wert des ausgewählten Parameters. |
Löschen |
Löscht den ausgewählten Parameter aus der TRESTRequest-Parameterliste. |
Authentifizierung
Für die meisten Dienste ist eine Authentifizierung erforderlich. Ein Authentifikator wird dem Client hinzugefügt und automatisch für jede abgeschlossene Anforderung ausgeführt.
Element | Beschreibung |
---|---|
Methode |
Legt die Standard-Authentifikatoren fest, die Rest-Clients beigefügt sind. |
Benutzername |
Repräsentiert die Eigenschaft AuthUsername der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit) Benutzername TEdit steht für Authentifikatoren vom Typ Simple und Basic zur Verfügung. |
Passwort |
Repräsentiert die Eigenschaft AuthPassword der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit) Passwort steht für Authentifikatoren vom Typ Simple und Basic zur Verfügung. |
Benutzername-Schlüssel |
Repräsentiert die Eigenschaft AuthUsernameKey der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit) Benutzername-Schlüssel ist für einfache (Simple) Authentifikatoren aktiviert. |
Passwort-Schlüssel |
Repräsentiert die Eigenschaft AuthPasswordKey der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit)Passwort-Schlüssel ist für einfache (Simple)-Authentikatoren aktiviert. |
Client-ID |
Repräsentiert die Eigenschaft ClientID der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit) Client-ID ist für die Methoden OAUTH und OAUTH2 verfügbar. |
Client-Secret |
Repräsentiert die Eigenschaft ClientSecret der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit) Client-Secret ist für die Methoden OAUTH und OAUTH2 verfügbar. |
Zugriffs-Token |
Repräsentiert die Eigenschaft AccessToken der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit)Zugriffs-Token ist für die Methoden OAUTH und OAUTH2 verfügbar. |
Anforderungs-Token |
Repräsentiert die Eigenschaft AccessTokenSecret der TRESTRequestParameterList-Instanz. Das Eingabefeld (TEdit)Anforderungs-Token ist für die Methoden OAUTH und OAUTH2 verfügbar. |
OAuth-Assistent |
Öffnet ein neues Fenster, das alle Parameterwerte für OAUTH- oder OAUTH2-Methoden enthält. Dieses neue geöffnete Fenster enthält Felder, die auf der Hauptseite der Authentifizierung nicht vorhanden sind, daher können Sie auch andere Dienste als Google oder Twitter verwenden. |
Verbindung
Auf der Registerkarte Verbindung geben Sie die Proxy-Eigenschaften von TRESTClient an.
Element | Beschreibung |
---|---|
Proxy-Server verwenden |
Aktivieren Sie das Kontrollkästchen (TCheckBox) Proxy-Server verwenden, oder lassen Sie es deaktiviert, um anzugeben, dass der TRESTClient mit Proxy-Servern arbeitet. |
Proxy-Server |
Legt die Eigenschaft ProxyServer von TRESTClient fest. |
Proxy-Port |
Legt die Eigenschaft ProxyPort von TRESTClient fest. Die Vorgabe für den Wert von ProxyPort ist 0. |
Benutzername |
Legt die Eigenschaft ProxyUsername von TRESTClient fest. |
Passwort |
Legt die Eigenschaft ProxyPassword von TRESTClient fest. |
Anforderungs-Schaltflächen
Element | Beschreibung |
---|---|
Anforderung senden |
Konfiguriert den Proxy-Server bei Bedarf, definiert die Eigenschaften BaseURL und Resource und die TRESTRequest-Methode. Klicken Sie auf die Schaltfläche Anforderung senden, um TRESTRequest auszuführen und die Antwort anzuzeigen. |
Neue Anforderung |
Setzt die Standardwerte der Felder Anforderung, Parameter, Authentifizierung und Verbindung wieder her. |
Anforderung laden |
Lädt anhand der Komponente TOpenDialog die Eigenschaftswerte für TRESTClient, TRESTRequest oder TRESTResponse aus der ausgewählten Datei. |
Anforderung speichern |
Speichert die Eigenschaftswerte der Komponente TRESTClient, TRESTRequest oder TRESTResponse in der Datei. |
Komponenten kopieren |
Kopiert die Komponenten TRESTClient, TRESTRequest und TRESTResponse in die Zwischenablage. Sie können diese Komponenten in die Zwischenablage kopieren und sie dann in den Formular-Designer einfügen. |
Der Antwortbereich
Auf der Seite Antwort können Sie die von dem Dienst über die Klasse TRESTResponse zurückgegebenen Daten einsehen.
Es gibt drei Beschriftungen in dem Gruppenfeld (TGroupBox) mit der vom Dienst empfangenen Antwort: Die Beschriftungen LastRequest URL und LastRequest Stats befinden sich im oberen Bereich des Gruppenfeldes und die Beschriftung Proxy State im unteren Bereich des Gruppenfeldes.
Element | Beschreibung |
---|---|
LastRequest URL |
Zeigt die Eigenschaft BaseURL von TRESTClient an. |
LastRequest Stats |
Enthält Informationen zu:
|
Proxy State |
Gibt an, ob der ProxyServer aktiviert ist oder nicht. |
Header
Der Antwort-Header enthält Schlüssel=Wert-Paare und Informationen, wie z. B. Datum, Größe und Typ der Datei, die der Server an den Client sendet, sowie Daten über den Server selbst.
Die durch den Server abgerufenen HTTP-Header-Felder unterscheiden sich von API zu API.
Element | Beschreibung |
---|---|
ResponseHeader |
Zeigt die Eigenschaft Headers von TRESTResponse an. |
Rumpf
Die Antwort enthält alle vom Dienst zurückgegebenen Daten. Die Daten umfassen den HTTP-Statuscode, Fehlermeldungen (falls vorhanden) und die zurückgegebenen JSON-Daten.
Auf die Antwortdaten kann mit einer der folgenden Eigenschaften zugegriffen werden: Content, JSONValue oder RAWbytes.
Element | Beschreibung |
---|---|
LabelJSON |
Legt fest, ob:
|
JSON-Stammelement |
Repräsentiert die Eigenschaft RootElement von TRESTResponse. Fügen Sie das gewünschte Stammelement in das JSON-Stammelement TClearingEdit ein. |
ResponseBody |
Zeigt alle zurückgegebenen Daten von dem Dienst an, der direkt nach dem Header aufgeführt ist. |
Anwenden |
Begrenzt den Inhalt des angezeigten Antwortrumpfs auf Basis der Eigenschaft RootElement. |
Tabellendaten
Eine im JSON-Format vorliegende Antwort eines Dienstes kann mit einem Datenmengenadapter in eine von TDataSet abgeleitete Klasse umgewandelt werden.
Jedes JSON-Objekt wird zu einem neuen Datensatz in der Datenmenge. Die Eigenschaften von JSON-Objekten bilden normalerweise die Spalten in der Datenmenge.
Element | Beschreibung |
---|---|
StringGrid |
Zeigt die Antwort in Form einer Datenmenge an. |
Zurück
Installieren des REST-Debuggers