Utilisez des exemples de demandes adressées à une ressource d’API pour générer des associations d’en-tête de demande, des associations de paramètres de requête et un schéma de demande pour cette ressource.
Avant de commencer
Un administrateur d’instance doit définir la propriété glide.rest.sampling.enabled système sur true. Pour limiter la probabilité de problèmes de performances, activez uniquement la génération automatique de définitions de demandes d’API dans les instances de non-production.
Rôle requis : web_service_admin
Procédure
-
Créez une configuration d’échantillonnage de demande d’API REST scriptée de l’une des façons suivantes.
| Option | Procédure |
|---|
| Parcourir un enregistrement scripté d’API REST |
- Accédez à la .
- Sélectionnez un enregistrement d’API REST scripté.
- Dans la liste connexe Ressources , sélectionnez une ressource.
- Dans l’onglet Configuration de l’échantillonnage de demande , sélectionnez Nouveau.
|
| Accéder directement à une nouvelle configuration d’échantillonnage de demande API REST scriptée |
- Accédez à la .
- Sélectionnez Nouveau.
- Dans le champ Ressource REST , sélectionnez ou saisissez la ressource REST scriptée pour laquelle générer automatiquement des définitions de demande.
|
-
Dans le champ Max samples (Nombre maximal d’échantillons ), saisissez le nombre d’exemples de demandes à analyser pour la génération automatique de définition.
Vous devez entrer un nombre compris entre 1 et 1000.
-
Sélectionnez Envoyer.
Les demandes adressées à la ressource sont échantillonnées à des fins d’analyse, jusqu’au nombre d’échantillons que vous avez défini à l’étape 5. Une fois le nombre maximal d’échantillons atteint, l’état de configuration de l’échantillonnage de demande est défini sur analysé et les schémas intermédiaires de demande REST peuvent être examinés.
Vous pouvez sélectionner Terminer l’échantillonnage à partir de l’enregistrement de configuration de l’échantillonnage de demande pour terminer l’échantillonnage avant que le nombre maximal d’échantillons ne soit atteint.
-
Une fois l’échantillonnage terminé, revenez à la configuration d’échantillonnage de demande que vous avez créée en sélectionnant son numéro dans l’onglet Configuration de l’échantillonnage de demande de la ressource REST scriptée.
-
Sélectionnez un enregistrement dans la liste Schémas intermédiaires de demande REST pour examiner et modifier les définitions de demande générées automatiquement dans les champs En-têtes, Corps et Paramètres de requête .
La structure du corps n’est générée que pour PUT les méthodes HTTP et POST .
-
Sélectionnez Valider pour ajouter les définitions à la ressource API REST scriptée et à son service API REST scripté associé.
Résultats
- Le schéma intermédiaire de demande REST validé et les exemples de demandes sont supprimés.
- Le contenu du champ En-têtes est utilisé pour créer les associations d’en-tête de demande de la ressource. Les en-têtes de demande associés sont ajoutés à l’onglet En-têtes de demande du service REST pertinent.
- Le contenu du champ du corps est utilisé pour créer le schéma de la demande de la ressource. Le schéma de demande de la ressource est ajouté à l’onglet Schémas du service REST pertinent.
- Le contenu du champ Paramètres de requête est utilisé pour créer les associations de paramètres de requête de la ressource. Les paramètres de requête associés sont ajoutés à l’onglet Paramètres de requête du service REST pertinent.
- Toutes les définitions de demande validées que vous avez ajoutées sont incluses dans la spécification OpenAPI exportable dans l’explorateur d’API REST. Pour plus d’informations sur l’exportation des spécifications OpenAPI, reportez-vous à la section Exporter vers la spécification OpenAPI.