Accéder au contenu principal Passer au contenu complémentaire

Spécifications OpenAPI

Les spécifications OpenAPI sont une collection d'outils qui vous aident à concevoir, construire, documenter et consommer des API.

Les spécifications OpenAPI sont similaires au Web Services Definition Language (WSDL) qui décrit des interactions entre le client et le serveur à l'aide de l'API REST. Pour plus d'informations, consultez la documentation spécification OpenAPI (uniquement en anglais).

En plus d'intéractions client/serveur, un fichier de spécifications OpenAPI inclut également des descriptions pour les structures de données d'entrée et de sortie. Lorsque vous importez des fichiers de spécifications OpenAPI à l'aide de l'option JSON OpenAPI Specifications (Spécifications OpenAPI JSON), Talend Data Mapper extrait les descriptions des structures de données et crée une Structure avec une représentation JSON par défaut. Par exemple, consultez l'exemple YAML et l'exemple JSON.

Fonctionnalités supportées

La liste suivante regroupe des informations utiles lors de l'import des spécifications OpenAPI dans une Structure :

  • Toutes les Structures importées sont simples. Les types primitifs dans les spécifications OpenAPI incluent le mélange habituel de type string, integer et float/double.

  • Les tableaux sont convertis en des éléments répétables dans Talend Data Mapper (Boucles).

  • La fonctionnalité de spécifications OpenAPI additionalProperties (uniquement en anglais) convertie en un groupe de type MAP dans Talend Data Mapper.

  • La construction allOf (uniquement en anglais) convertit naturellement en un héritage Talend Data Mapper.

  • Le oneOf and anyOf (uniquement en anglais) convertit en un Choix dans Talend Data Mapper.
    Note InformationsRemarque : Le Choix dans Talend Data Mapper ne correspond pas exactement à la sémantique de anyOf. Dans le schéma d'exemple ci-après, remarquez que le JSON peut être un Chat, un Chien ou les deux. Talend Data Mapper ne supporte pas les deux cas.
    CatOrDog:
      anyOf:
        - $ref: '#/components/schemas/Cat'
        - $ref: '#/components/schemas/Dog'

Dans cette section

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici