Création de spécifications OpenAPI personnalisées

Ce modèle peut être utilisé pour créer un nouveau fichier JSON de spécification Swagger.
Tableau 1. Modèle pour le fichier JSON de spécification Swagger
Nom de zone Type Spécification
openapi chaîne REQUIS. Cette chaîne doit être le numéro de version sémantique de la version de spécification OpenAPI qu'utilise le document OpenAPI. Cette zone openapi doit être utilisée par les spécifications d'outils et les clients pour interpréter le document OpenAPI. Elle n'est pas liée à la chaîne info.version d'API.
info Objet info REQUIS Fournit des métadonnées sur l'API. Les métadonnées peuvent être utilisées par les outils selon les besoins.
serveurs [Objet Serveur] Matrice d'objets serveur qui fournit des informations de connectivité à un serveur cible. Si la propriété servers n'est pas fournie ou s'il s'agit d'une matrice vide, la valeur par défaut est un objet serveur avec une valeur d'URL de /.
paths Objet Chemins d'accès REQUIS. Chemins et opérations disponibles pour l'API.
composants Objet Composants Elément qui permet de contenir différents schémas pour la spécification.
sécurité [Objet Exigences de sécurité] Déclaration des mécanismes de sécurité qui peuvent être utilisés dans l'API. La liste des valeurs inclut d'autres objets d'exigence de sécurité qui peuvent être utilisés. Un seul des objets d'exigence de sécurité doit être satisfait pour autoriser une requête. Les opérations individuelles peuvent écraser cette définition. Pour rendre la sécurité facultative, une exigence de sécurité vide ({}) peut être incluse dans la matrice.
tags [Objets Balise] Liste des balises utilisées par les spécifications avec des métadonnées supplémentaires. L'ordre des balises peut être utilisé pour refléter leur ordre par les outils d'analyse. Toutes les balises utilisées par l'objet Opération ne doivent pas être déclarées. Les balises qui ne sont pas déclarées peuvent être organisées de manière aléatoire ou en fonction de la logique de l'outil. Chaque nom de balise de la liste doit être unique.
externalDocs Objet de documentation externe Documentation externe supplémentaire.