Inserito il: Dec 1, 2016
Ora puoi aggiungere documentazione ai tuoi metodi e risorse per le API create usando Amazon API Gateway, consentendo ai tuoi clienti API di comprendere facilmente l’API. Puoi aggiungere documentazione per l'API direttamente utilizzando la console API Gateway, l'interfaccia a riga di comando e SDK, o semplicemente specificandolo con i tag della documentazione nell'ambito della definizione Swagger per l'API. Puoi anche riutilizzare la documentazione su aspetti comuni dell'API. Ad esempio, puoi creare documentazione standard sugli errori una sola volta e utilizzarla in più risposte API senza duplicare il contenuto effettivo, accelerando la documentazione delle tue API ed eliminando gli errori di copia-e-incolla che possono scaturire dalle stringhe duplicate. Una volta che la documentazione è pubblicata nell'ambito della fase API, puoi esportarla utilizzando la funzione di esportazione Swagger e rendendola disponibile nel tuo portale per sviluppatori.
API Gateway ti fornisce flussi di lavoro indipendenti per la definizione e la documentazione API. Ciò consente agli sviluppatori API e agli autori tecnici di lavorare in parallelo e importare il proprio Swagger separatamente utilizzando la console, la CLI e SDK.
Per ulteriori informazioni, consulta Documentazione di un API Gateway.