Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Esporta un file REST API da API Gateway
Dopo aver creato e configurato un REST API in API Gateway, utilizzando la console API Gateway o in altro modo, puoi esportarlo in un API file aperto utilizzando API Gateway ExportAPI, che fa parte di Amazon API Gateway Control Service. Per utilizzare API Gateway ExportAPI, devi firmare API le tue richieste. Per ulteriori informazioni sulla firma delle richieste, consulta la AWS APIsezione Richieste di firma nella Guida IAM per l'utente. È possibile includere le estensioni di integrazione API Gateway, nonché le estensioni Postman
Nota
Quando esportate API utilizzando il AWS CLI, assicuratevi di includere il parametro extensions come mostrato nell'esempio seguente, per assicurarvi che l'x-amazon-apigateway-request-validatorestensione sia inclusa:
aws apigateway get-export --parameters extensions='apigateway' --rest-api-id abcdefg123 --stage-name dev --export-type swagger latestswagger2.json
Non è possibile esportare un API file se i relativi payload non sono del application/json tipo. Se ci provi, riceverai una risposta di errore che indica che i modelli JSON corporei non sono stati trovati.
Richiesta di esportazione di un REST API
Con l'opzione ExportAPI, si esporta un REST API file esistente inviando una GET richiesta, specificandolo to-be-exported API come parte dei URL percorsi. La richiesta ha URL il seguente formato:
È possibile aggiungere la stringa di extensions query per specificare se includere le estensioni API Gateway (con il integration valore) o le estensioni Postman (con il postman valore).
Inoltre, è possibile impostare l'Acceptintestazione su application/json o application/yaml ricevere l'output della API definizione rispettivamente in JSON o in YAML formato.
Per ulteriori informazioni sull'invio di GET richieste utilizzando API Gateway ExportAPI, vedere. GetExport
Nota
Se definisci i modelli nel tuoAPI, per consentire a API Gateway di esportare il modello devono corrispondere al tipo di contenuto «application/json». In caso contrario, API Gateway genera un'eccezione con il messaggio di errore «Only found JSON non-body models for...».
I modelli devono contenere proprietà o essere definiti come un JSONSchema tipo particolare.
Scarica REST API Open API definition in JSON
Per esportare e scaricare un file REST API in API Definizioni aperte in JSON formato:
Qui <region>us-east-1. Per tutte le regioni in cui API Gateway è disponibile, consulta Regioni ed endpoint.
Scarica REST API Open API definition in YAML
Per esportare e scaricare un file REST API in API Definizioni aperte in YAML formato:
Scarica REST API Open API definition con le estensioni Postman in JSON
Per esportare e scaricare un file REST API in API Definizioni aperte con Postman in JSON formato:
Scarica REST API Open API definition con integrazione API Gateway in YAML
Per esportare e scaricare un file REST API in API definizioni aperte con integrazione API Gateway in YAML formato:
Esportazione REST API tramite la console API Gateway
Dopo la REST API distribuzione su uno stage, potete procedere all'esportazione dello stage API in un API file Open utilizzando la console API Gateway.
Nel riquadro Stages della console API Gateway, scegliete Stage actions, Export.
Specificate il tipo di API specifica, il formato e le estensioni per scaricare API la vostra API definizione aperta.
