Définir un schéma API REST

Spécifiez la structure de données attendue pour les demandes ou les réponses au sein d’une API REST en définissant un schéma.

Avant de commencer

Rôle requis : web_service_admin

Pourquoi et quand exécuter cette tâche

Les schémas sont des enregistrements qui définissent la structure et le format des corps et des en-têtes de demande et de réponse pour une API REST au format OpenAPI 3.0.1. Lorsque vous définissez un schéma dans le ServiceNow AI Platform, le schéma est utilisé pour définir la structure des demandes et des réponses au sein de l’API REST associée. Les données de schéma pour les demandes et les réponses sont ensuite disponibles dans la spécification OpenAPI exportable pour l’API. Pour plus d’informations sur l’exportation des spécifications OpenAPI, reportez-vous à la section Exporter vers la spécification OpenAPI.

La procédure suivante décrit le processus de définition manuelle des schémas. Pour plus d’informations sur la génération automatique de définitions de schéma de demande dans les instances de non-production, reportez-vous à la section Générer automatiquement des définitions de demandes d’API.

Procédure

1. Créez un schéma REST de l’une des façons suivantes.

   Option	Procédure
   Parcourir un enregistrement scripté d’API REST	Accédez à la Tous > Services web système > API REST basées sur un script. Sélectionnez un enregistrement d’API REST scripté. Dans la liste connexe Schémas , sélectionnez Nouveau.
   Accéder directement à un nouvel enregistrement de schéma REST	Accédez à la Tous > Filtre et accédez à sys_ws_schema.form. Dans le champ API , sélectionnez ou entrez l’API à associer au schéma.

2. Dans le champ Nom , saisissez un nom pour le schéma.
3. Dans le champ Schéma , définissez le type de données et la structure du nouveau schéma à l’aide du format OpenAPI version 3.0.1.
   Par exemple, l’entrée suivante spécifie que le schéma est un objet qui contient un prénom. Le premier nom est un type de données chaîne.

   { "type": "object", "properties": { "firstName": { "type": "string" } } }

4. Sélectionnez une version d’OpenAPI.
5. Dans le champ Description , résumez la structure attendue du nouveau schéma.
6. Sélectionnez Envoyer.

Que faire ensuite

Définissez des schémas supplémentaires si nécessaire. Utilisez les schémas pour spécifier la structure et le format attendus dans une demande ou une réponse REST. Pour plus d'informations, voir Définir une structure de demande de ressource d’API ou Définir une structure de réponse de ressource d’API.