Documentazione per le API REST in API Gateway - Amazon API Gateway

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à.

Documentazione per le API REST in API Gateway

Per aiutare i clienti a comprendere e utilizzare la tua API, è fondamentale documentarla. Per aiutarti a documentare l'API, API Gateway ti consente di aggiungere e aggiornare il contenuto della guida per le singole entità API come parte integrante del processo di sviluppo dell'API. API Gateway memorizza il contenuto di origine e ti consente di archiviare diverse versioni della documentazione. Puoi associare una versione della documentazione a una fase API, esportare uno snapshot di documentazione specifico della fase in un file OpenAPI esterno e distribuire il file come pubblicazione della documentazione.

Per documentare la tua API, puoi chiamare l'API REST di API Gateway, utilizzare uno degli AWS SDK, utilizzare AWS CLIfor API Gateway o utilizzare la console API Gateway. Inoltre, puoi importare o esportare le parti della documentazione definite in un file OpenAPI esterno.

Per condividere la documentazione API con gli sviluppatori, puoi utilizzare un portale per sviluppatori. Per un esempio, consulta Integrazione ReadMe con API Gateway per mantenere aggiornato il tuo Developer Hub o Come semplificare lo sviluppo di API su Amazon API Gateway Using SmartBear SwaggerHub sul blog AWS Partner Network (APN).

Argomenti