RAD Server-Endpunkte
Nach oben zu Verwenden der Anwendung "RAD Server Management Console"
Über die Anwendung "RAD Server Management Console" können Sie Ihre RAD Server-REST-APIs abfragen, die JSON-Antwort anzeigen und mit unterschiedlichen Parametern und HTTP-Methoden über einen integrierten REST-Debugger Tests durchführen.
Inhaltsverzeichnis
Menü
Mit den Menüoptionen der Option "Endpunkte" in der Anwendung "RAD Server Management Console" verwalten Sie Anforderungen:
Anforderung senden (F9): Konfiguriert den Proxy-Server bei Bedarf, definiert die BaseURL- und Resource-Eigenschaften und die Methode TRESTRequest. Klicken Sie auf die Schaltfläche "Anforderung senden", um TRESTRequest auszuführen und die Antwort anzuzeigen.
Neue Anforderung: Setzt die Felder auf den Seiten "Anforderung", "Parameter", "Authentifizierung" und "Verbindung" auf ihre Standardwerte zurück.
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 eine 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.
Anforderung
Geben Sie im Abschnitt Anforderung die Eigenschaften von TRESTClient und TRESTRequest an.
Methode
Listet die TRESTRequest-Methoden wie folgt auf:
POST übergibt zu verarbeitende Daten an die TRESTRequest-Ressource.
PUT aktualisiert Daten für die TRESTRequest-Ressource.
GET fordert Daten von der TRESTRequest-Ressource an.
DELETE löscht die Daten aus der TRESTRequest-Ressource.
PATCH passt die Daten in der TRESTRequest-Ressource an, indem nur die in diesem PATCH-Rumpf gesendeten Paare aktualisiert werden.
Endpunkt
Ressource aus dem REST-Debugger, wird automatisch mit den benutzerdefinierten Endpunkten auf RAD Server ausgefüllt.
Inhaltstyp
Legt die Eigenschaft ContentType von TRESTRequestParameterList fest.
- application/atom+xml
- application/json
- application/vnd.embarcadero.firedac+json
- application/xml
- application/x-www-form-urlendcode
- text/html
Anforderungsparameter
Legt die TRESTRequest-Parameter fest. Es gibt verschiedene Parametertypen:
Header-Parameter haben das Format "Schlüssel=Wert" und werden in den HTTP-Header der Anforderung integriert.
Post/Get-Parameter haben das Format "Schlüssel=Wert". Bei HTTP-Post-Anforderungen werden die Post-Parameter in den Rumpf der Anfrage integriert. Bei HTTP-Get-Anforderungen werden die Get-Parameter als Teil des Abfrage-Strings in die URL integriert.
Rumpf-Parameter bestehen aus nur einem Wert und werden in den TRESTRequest-Rumpf integriert.
URL-Segment-Parameter haben das Format "Schlüssel=Wert" und ihr Wert wird an die HTTP-URL vor dem Abfrage-String der Anforderung angehängt. Mehrere URL-Segment-Parameter werden durch einen umgekehrten Schrägstrich (Backslash, \) getrennt.
Cookie-Parameter haben das Format "Schlüssel=Wert" und werden als Cookie-Werte gesendet.
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.
Benutzerdefinierter Rumpf
Legt die Eigenschaft CustomBody von TRESTRequestParameterList fest.
Antwort
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 erforderliche Stammelement in das JSON-Stammelement TClearingEdit ein. |
|
ResponseBody |
Zeigt alle zurückgegebenen Daten des Dienstes 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. |