Crea una pagina di prodotto in API Gateway - Gateway Amazon API
ConsiderazioniCrea una pagina di prodotto

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 una pagina di prodotto in API Gateway

Una pagina di prodotto aiuta i consumatori a comprendere e utilizzare i prodotti. La documentazione è a livello di prodotto, quindi tutti i portali che includono il prodotto dispongono di questa documentazione. API Gateway supporta due tipi di pagine di prodotto scritte in GitHub Flavored Markdown:

Pagina di panoramica

Quando crei il prodotto, API Gateway genera automaticamente una pagina di panoramica del prodotto in base alle informazioni fornite durante la creazione del prodotto. Questa pagina ha una formattazione aggiuntiva che non può essere modificata. È possibile modificare il testo o rimuovere la pagina dal prodotto del portale.

Pagine personalizzate

Una pagina personalizzata è una pagina scritta in Markdown. Puoi utilizzare questa sezione per i termini e le condizioni o per un tutorial su come utilizzare il tuo prodotto. Puoi modificare qualsiasi pagina personalizzata in una pagina di panoramica. Quando si modifica una pagina personalizzata in una pagina di panoramica, il contenuto della pagina viene formattato in modo da corrispondere alla pagina di panoramica.

Considerazioni

Le seguenti considerazioni potrebbero influire sull'utilizzo delle pagine dei prodotti:

  • Questa documentazione non è a livello di API e non include metodi, risorse o parametri di richiesta. Per informazioni su come modificare la documentazione a livello di API per un prodotto, consulta. Aggiorna un endpoint REST del prodotto in API Gateway

  • Non puoi caricare direttamente un .md file sul tuo prodotto.

  • Puoi modificare l'ordine delle pagine dei prodotti modificando l'elenco delle pagine nell'ordine di visualizzazione del prodotto del portale. Per ulteriori informazioni, consulta Aggiornare un prodotto del portale in API Gateway.

  • È necessario ripubblicare tutti i portali che includono il prodotto affinché le modifiche alla documentazione abbiano effetto.

  • Se disponi di più portali che utilizzano lo stesso prodotto del portale, le pagine dei prodotti sono le stesse in tutti i portali. Per avere gli stessi endpoint REST del prodotto ma pagine di prodotto diverse, crea più prodotti.

Crea una pagina di prodotto

La procedura seguente mostra come creare una pagina di prodotto.

Per creare una pagina di prodotto

  1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Nel riquadro di navigazione principale, scegli i prodotti del portale.

  3. Scegli un prodotto.

  4. In Documentazione, scegli Crea pagina personalizzata.

  5. Per Titolo della pagina, inserisci il titolo della pagina.

  6. Per Body, inserisci la tua documentazione supplementare utilizzando GitHub Flavored Markdown.

    La sezione Anteprima mostra come i tuoi contenuti appaiono in un portale. Lo stile visivo finale potrebbe cambiare in base alle impostazioni del portale.

  7. Scegli Crea pagina di prodotto.

  8. La pagina del prodotto è ora una bozza. Scegli Bozze di documentazione, quindi scegli la pagina del prodotto per finalizzare il contenuto della pagina.

  9. Scegli Modifica pagina.

  10. Per Nome sezione, inserisci un nome o scegli una sezione esistente. Quando aggiungi la pagina del prodotto a una sezione, i consumatori possono visualizzare i tuoi contenuti su un portale pubblicato.

  11. Scegli Save changes (Salva modifiche).

Per consentire alla nuova pagina di essere visibile ai consumatori, devi comunque ripubblicare il portale. Per ulteriori informazioni, consulta Pubblica un portale in API Gateway.