Via Altova XMLSpy
L'application XMLSpy d'Altova intègre des fonctionnalités HTTP qui vous permettent d'interagir facilement avec des documents OpenAPI et d'envoyer des requêtes HTTP à partir de ceux-ci. Vous pouvez tester cette fonctionnalité à l'aide du fichier Raptor OpenAPI (au format YAML) fourni avec Altova XMLSpy, dans le dossier Examples. Ce fichier vous permet de communiquer avec l’API du serveur HTTP Raptor.
Dans XMLSpy, vous pouvez ouvrir ce fichier de l’une des manières suivantes : RaptorXmlXbrl.openapi.yaml Le fichier se trouve dans le dossier :
•À partir du projet Examples d’Altova XMLSpy. Dans la fenêtre Projet d’XMLSpy, cliquez sur le fichier OpenAPI Examples | RaptorXmlXbrl.openapi.yaml.
•Le chemin d’accès au fichier sur votre système est le suivant : C:\Users\<username>\Documents\Altova\XMLSpy2027\Examples\RaptorXmlXbrl.openapi.yaml. Si vous avez installé une version 32 bits d’Altova XMLSpy, le dossier sera Program Files (x86).
Note : assurez-vous que le service RaptorXML Server a été démarré (Windows, Linux) avant d'envoyer vos requêtes HTTP.
Note : le mécanisme d'envoi de requêtes à l'API HTTP de RaptorXML Server et de réception des réponses est décrit dans la section Requêtes client.
Documents OpenAPI dans XMLSpy
Altova XMLSpy peut générer une requête HTTP directement à partir des chemins d’opération individuels d’un document OpenAPI. Par exemple, dans la capture d'écran ci-dessous, vous pouvez cliquer avec le bouton droit sur n'importe quelle requête HTTP du fichier OpenAPI, par exemple /version/get, puis sélectionner Nouvelle requête HTTP dans le menu contextuel qui s'affiche.
Le dialogue Paramètres de requête HTTP s'affiche, avec les valeurs des paramètres préremplies en fonction des données du fichier OpenAPI. Une fois les informations relatives aux paramètres renseignées et après avoir cliqué sur OK, l'URL de la requête s'affiche dans la fenêtre HTTP d'XMLSpy. Vous pouvez vérifier la requête avant de l'envoyer à l'API du serveur. La réponse du serveur s'affiche dans le volet de droite de la fenêtre HTTP.
Se connecter à Raptor et récupérer les informations de version via GET
Si vous créez une requête sur le chemin /version, le dialogue Paramètres de requête HTTP illustré dans la capture d’écran ci-dessous s’affiche. Dans ce dialogue, les valeurs des paramètres de connexion sont renseignées en fonction des données du fichier OpenAPI (comparez avec les données de connexion de la capture d’écran ci-dessus). Notez que, selon le fichier OpenAPI (voir la capture d’écran ci-dessus), le champ Protocol peut prendre l’une des deux valeurs suivantes : http ou https. C’est pourquoi le champ Protocol du dialogue comporte une liste déroulante qui limite votre choix à l’une de ces deux valeurs. Notez également que le champ URI sortie construit la requête HTTP qui sera utilisée pour obtenir les informations de version.
Lorsque vous cliquez sur OK, la fenêtre HTTP s'affiche avec la requête GET prête à être envoyée (capture d'écran ci-dessous). Cliquez sur Envoyer dans la fenêtre HTTP. La requête est envoyée et la réponse du serveur s'affiche dans le volet de droite de la fenêtre (capture d’écran ci-dessous).
Si vous obtenez une erreur, vous pouvez effacer la réponse, corriger l'erreur et exécuter à nouveau. Les erreurs courantes sont des échecs de connexion, qui peuvent être dus au fait que RaptorXML Server n'a pas été correctement démarré ou n'a pas de licence.
Envoyer une requête POST, récupérer la réponse du serveur via GET
Pour envoyer une requête POST en vue d'une validation XML, procédez comme suit :
1.Cliquez avec le bouton droit sur /queue/post dans la vue Texte ou la vue Grille d'XMLSpy, puis sélectionnez Nouvelle requête HTTP dans le menu contextuel.
2.Dans le dialogue Sélectionner type de contenu du corps de la requête qui s'affiche, sélectionnez xml_validation, puis cliquez sur OK.
3.Dans le dialogue Paramètres de la requête HTTP qui s'affiche, vérifiez les données préremplies, puis cliquez sur OK.
4.La fenêtre HTTP contient désormais la requête POST avec les données extraites du fichier OpenAPI (capture d'écran ci-dessous). Vous pouvez modifier les valeurs des paramètres ici si vous le souhaitez. Par exemple, la commande de validation XML de RaptorXML Server nécessite que des fichiers XML et XSD soient spécifiés en tant que fichiers supplémentaires. Dans la fenêtre HTTP, vous pouvez sélectionner le fichier XML de votre choix (dans le champ additional-files). Cliquez sur Envoyer lorsque vous avez terminé.
La réponse du serveur s’affichera dans le volet de droite (voir la capture d’écran ci-dessus). La réponse contient un identifiant de tâche et l’emplacement du fichier contenant le résultat de la validation. Pour plus d’informations, consultez la rubrique Réponse du serveur à une requête POST. L’identifiant de tâche sera nécessaire lors de la prochaine requête GET, qui permet de récupérer le fichier de résultat de validation (validation-result). Pour créer cette requête HTTP GET, cliquez avec le bouton droit de la souris sur la description de la requête GET. Dans le dialogue Paramètres de la requête HTTP qui s’affiche, saisissez l’identifiant de tâche comme valeur du paramètre jobId, puis envoyez la requête.
En suivant les étapes décrites ci-dessus, vous pouvez effectuer les opérations suivantes :
1.Créer d'autres requêtes HTTP à partir de n'importe quelle description de requête dans l'OpenAPI. Notez que vous pouvez conserver une ancienne requête et en créer une nouvelle dans un onglet portant un nouveau numéro.
2.Remplir ou modifier les valeurs des paramètres dans le dialogue Paramètres de la requête HTTP
3.Envoyer la requête à partir de la fenêtre HTTP
4.Visualiser la réponse du serveur dans la fenêtre HTTP.
Pour plus d'informations sur les réponses du serveur, consultez les rubriques Réponse de serveur à une requête POST, Obtenir le document de résultat et Obtenir documents d’erreur/de message/de sortie.