Exporter une définition pour AWS API Gateway - Cloud

Guide d'utilisation de Talend Cloud API Designer

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Création et développement > Création d'APIs
EnrichPlatform
Talend API Designer
Exportez une définition d'API compatible avec AWS API Gateway ou Azure API Management.

Procédure

  1. Ouvrez l'API que vous souhaitez exporter en cliquant sur API > Open et en sélectionnant votre API.
  2. Cliquez sur EXPORT.
  3. Cliquez sur OpenAPI Specification et sélectionnez AWS API Gateway ou Azure API Management.
    Si vous souhaitez exporter votre API vers une autre passerelle, Apigee par exemple, il est recommandé de sélectionner Standard OAS.
  4. Sélectionnez la version et le format d'OAS.
    Puisque les extensions Talend ne sont pas supportées par les passerelles d'API, No extensions est l'option sélectionnée par défaut et ne peut être modifiée.
  5. Si vous ne souhaitez pas exporter votre API complète, cliquez sur Filter export et sélectionnez les opérations à exporter.

    Lorsque vous filtrez votre export, tous les types de données, composants et ressources sont exportés, quelles que soient les opérations sélectionnées.

    Remarque :
    Les ressources sont exportées même si elles ne contiennent aucune opération ou si leurs opérations sont filtrées et masquées. Par exemple, dans l'image ci-dessous, toutes les opérations dans la ressource /contact/{contactid} sont filtrées et masquées, mais le chemin s'affiche toujours dans le fichier exporté :
    "/contacts/{contactid}" : {
          "parameters" : [ {
            "$ref" : "#/components/parameters/contactid"
          } ]
        }

    La passerelle AWS API Gateway affiche un avertissement lors de l'import d'un fichier contenant des chemins sans opération, mais cela n'empêche pas l'import.

  6. Cliquez sur Export.