Points de terminaison RAD Server
Remonter à Utilisation de l'application RAD Server Management Console
L'application RAD Server Management Console (Console de gestion RAD Server) vous permet d'interroger vos API REST RAD Server, de voir la réponse JSON et d'effectuer des tests avec différents paramètres et différentes méthodes HTTP par l'intermédiaire d'un débogueur REST intégré.
Sommaire
Menu
Utilisez les options du menu Points de terminaison dans l'application RAD Server Management Console pour gérer les requêtes :
Envoyer la requête (F9) : Configure le serveur proxy si nécessaire, définit les propriétés BaseURL et Resource, ainsi que la méthode TRESTRequest. Cliquez sur le bouton Envoyer la requête pour exécuter TRESTRequest et afficher la réponse.
Nouvelle requête : Rétablit la valeur par défaut des champs des pages Requête, Paramètres, Authentification et Connexion.
Charger la requête : Utilise le composant TOpenDialog pour charger les valeurs des propriétés de TRESTClient, TRESTRequest ou TRESTResponse à partir du fichier sélectionné.
Enregistrer la requête : Enregistre dans un fichier les valeurs des composants TRESTClient, TRESTRequest ou TRESTResponse.
Copier les composants : Copie les composants TRESTClient, TRESTRequest et TRESTResponse dans le Presse-papiers. Vous pouvez copier ces composants dans le Presse-papiers, puis les coller dans le Concepteur de fiches.
Requête
Utilisez la section Requête pour spécifier les propriétés TRESTClient et TRESTRequest.
Méthode
Liste les méthodes TRESTRequest, comme suit :
POST soumet les données à traiter à la ressource TRESTRequest.
PUT met à jour les données pour la ressource TRESTRequest.
GET demande des données à la ressource TRESTRequest.
DELETE supprime les données de la ressource TRESTRequest.
PATCH corrige les données sur la ressource TRESTRequest en mettant à jour uniquement les paires envoyées au sein de ce corps PATCH.
Point de terminaison
Ressource du débogueur REST, automatiquement remplie avec des points de terminaison personnalisés sur RAD Server.
Content-Type
Spécifie la propriété ContentType du TRESTRequestParameterList.
- application/atom+xml
- application/json
- application/vnd.embarcadero.firedac+json
- application/xml
- application/x-www-form-urlendcode
- text/html
Paramètres de la requête
Spécifie les paramètres TRESTRequest. Il existe différents types de paramètres :
Les paramètres d'en-têtes prennent la forme key=value et sont intégrés dans l'en-tête HTTP de la requête.
Les paramètres Post/Get prennent la forme key=value. Pour les requêtes HTTP POST, les paramètres Post sont intégrés dans le corps de la requête. Pour les requêtes HTTP GET, les paramètres Get sont intégrés dans l'URL en tant que partie de la chaîne de requête.
Les paramètres de corps ne comportent qu'une valeur et sont intégrés dans le corps de TRESTRequest.
Les paramètres de segment URL prennent la forme key=value et leur valeur est ajoutée à l'URL HTTP avant la chaîne de la requête. Les paramètres de segment URL multiples sont délimités par une barre oblique inverse (\).
Les paramètres de cookie prennent la forme key=value et sont envoyés comme valeurs de cookie.
Ajouter
Ajoute un nouveau paramètre à la liste des paramètres TRESTRequest. Spécifiez le type de paramètre à l'aide de la zone de liste déroulante Genre, le nom du paramètre dans la zone d'édition (TComboEdit) Nom et la valeur du paramètre dans la zone d'édition (TEdit) Valeur.
Modifier
Modifie un paramètre de la liste des paramètres TRESTRequest. Changez le type, le nom ou la valeur du paramètre sélectionné.
Supprimer
Supprime le paramètre sélectionné dans la liste de paramètres TRESTRequest.
Corps personnalisé
Spécifie la propriété CustomBody du TRESTRequestParameterList.
Réponse
En-têtes
L'en-tête de réponse contient des paires (key=value) et des informations comme la date, la taille et le type de fichier que le serveur envoie au client, ainsi que des données concernant le serveur lui-même.
Les champs d'en-tête HTTP récupérés par le serveur diffèrent d'une API à une autre.
| Elément | Description |
|---|---|
|
ResponseHeader |
Affiche la propriété Headers du TRESTResponse. |
Body
La réponse contient toutes les données renvoyées par le service. Ces données incluent le code d'état HTTP, les messages d'erreur (s'il en existe), et bien sûr les données JSON renvoyées.
Les propriétés suivantes permettent d'accéder aux données de réponse : Content, JSONValue ou RAWbytes.
| Elément | Description |
|---|---|
|
LabelJSON |
Spécifie si :
|
|
Elément racine JSON |
Représente la propriété RootElement de TRESTResponse. Insérez l'élément racine voulu dans la zone d'édition Elément racine JSON. |
|
ResponseBody |
Affiche toutes les données renvoyées par le service, qui se trouvent juste après l'en-tête. |
|
Appliquer |
Limite le contenu du corps de la réponse affiché, en fonction de la propriété RootElement. |
Données tabulaires
La réponse au format JSON d'un service peut être transformée en classe descendante de TDataSet avec un adaptateur d'ensemble de données.
Chaque objet JSON est un nouvel enregistrement dans l'ensemble de données. Les propriétés des objets JSON forment généralement les colonnes de l'ensemble de données.
| Elément | Description |
|---|---|
|
StringGrid |
Affiche la réponse organisée comme un ensemble de données. |