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à.
Crea un endpoint REST del prodotto in API Gateway
Un endpoint REST del prodotto è un punto di accesso al prodotto del portale. Ogni endpoint è costituito dal percorso e dal metodo di un'API REST e dalla fase in cui viene distribuito. L'endpoint include tutta la documentazione che hai definito per la tua API REST o può essere aggiornato con documentazione personalizzata. Quando crei l'endpoint REST del prodotto, configuri le seguenti impostazioni:
-
Il nome dell'operazione dell'endpoint REST del prodotto. Se l'API REST ha il percorso e il metodo
GET /pets, in un portale, il nome è/pets. Utilizzando il nome dell'operazione, è possibile modificare il nome dell'endpoint REST del prodotto inPet summaries. Ciò non ha alcun impatto sull'API esistente. -
La funzionalità di prova per l'endpoint del tuo prodotto. In questo modo i consumatori di API possono provare la vostra APIs applicazione nel vostro portale. Se crei un endpoint di prodotto per un'API privata, la funzionalità try it è impostata su.
UNAVAILABLEPer ulteriori informazioni, consulta Abilita «prova» per un endpoint REST del prodotto API Gateway nel tuo portale. -
Se attualmente disponi di parti di documentazione definite per la tua API REST, puoi importare la documentazione o sovrascrivere la documentazione esistente e creare nuova documentazione a livello di prodotto utilizzando Flavored Markdown. GitHub
Eventuali modifiche alla documentazione non si propagano alle parti della documentazione dell'API API Gateway. Se importi le parti della documentazione corrente, API Gateway sincronizza le modifiche tra l'API e l'endpoint REST del prodotto.
Crea un endpoint REST del prodotto
La procedura seguente mostra come aggiungere un endpoint REST del prodotto a un prodotto del portale esistente. Per informazioni su come creare insieme un prodotto del portale e un endpoint REST del prodotto, consulta. Crea un prodotto portale in API Gateway
Per creare un endpoint REST di prodotto per un portale di prodotti
Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.
Nel riquadro di navigazione principale, scegli i prodotti del portale.
Scegli un prodotto del portale.
Scegli la scheda Endpoint associati, quindi scegli Aggiungi endpoint.
-
Per selezionare gli endpoint REST del prodotto, in Endpoint API scegli un'API, quindi scegli una fase.
Per aggiungere un endpoint agli endpoint REST del prodotto, seleziona l'endpoint API, quindi scegli Aggiungi al prodotto.
L'endpoint API verrà visualizzato nell'elenco degli endpoint API selezionati.
Scegli Invia.
-
La pagina dell'endpoint REST del prodotto è ora una bozza. Scegli le pagine di riferimento dell'API Draft, quindi scegli la pagina dell'endpoint REST del prodotto per finalizzare il contenuto della pagina.
Scegli Modifica pagina.
-
Per sovrascrivere la documentazione esistente di API Gateway, per Documentation source, attiva Sostituisci la documentazione e procedi come segue:
Per Visualizza contenuto, scegli Create override.
Per Nome dell'operazione, inserisci un nuovo nome dell'operazione.
Per il corpo della pagina, inserisci la tua documentazione personalizzata.
-
(Facoltativo) Per Endpoint, inserisci un endpoint personalizzato che appare nel portale.
-
Per consentire ai clienti di richiamare l'API nel portale, seleziona Prova la funzionalità. Per ulteriori informazioni, consulta Abilita «prova» per un endpoint REST del prodotto API Gateway nel tuo portale.
-
Per Nome della sezione, inserisci un nome o scegli una sezione esistente. Quando aggiungi l'endpoint REST del prodotto a una sezione, i consumatori possono visualizzare i tuoi contenuti su un portale pubblicato.
Scegli Save changes (Salva modifiche).
Per consentire alla nuova pagina di essere visibile ai consumatori, devi comunque ripubblicare il tuo portale. Per ulteriori informazioni, consulta Pubblica un portale in API Gateway.
