Verifica di un'API con la pagina Esplora

Utilizzate la scheda Explorer nell'editor API per vedere come le vostre API appaiono a un utente del portale CMS. Puoi anche utilizzare lo strumento Try it per verificare il comportamento dell'API.

Prima di iniziare

Per verificare un'API nello strumento di test Try it , l'API deve essere pubblicata automaticamente. Se l'API non è pubblicata automaticamente, lo strumento Provalo non è abilitato in Explorer.

Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.

Informazioni su questa attività

La scheda Explorer nell'editor API dell' API Designer UI e dell' API Manager UI consente di visualizzare l'aspetto delle API per un consumatore API nel portale CMS. È possibile controllare le descrizioni dei diversi artefatti, nonché tutti gli schemi o gli esempi, e si può anche testare il comportamento dell'API utilizzando lo strumento Try it.

Nota:
  • Non puoi utilizzare lo strumento Provalo per testare le API non applicate.

Procedura

Per verificare un'API utilizzando lo strumento Provalo , completa la seguente procedura.

  1. Se si utilizza API Designer, impostare la modalità su Online utilizzando il menu Opzioni Menu Opzioni nella pagina principale.
  2. Nel riquadro di navigazione, fai clic su Icona di sviluppo nel riquadro di navigazione dell'interfaccia utente API Develop, quindi seleziona la scheda APIs.
  3. Fai clic sul titolo dell'API che vuoi utilizzare.
    Viene visualizzato l'editor API.
  4. Fare clic sulla scheda Explorer .
    Viene visualizzata una Panoramica dell'API.
  5. Fare clic sulle risorse utente API nella barra dei menu laterale per esplorare le operazioni e le definizioni disponibili nell'API, inclusa la revisione di eventuali esempi e schemi.
  6. Per verificare il funzionamento dell'API, fare clic su un'operazione nella barra dei menu laterale e fare clic sulla scheda Provalo .
    Viene visualizzato il riquadro di verifica per l'operazione, come mostrato nel seguente esempio:
    Il riquadro Prova della scheda Esplora.
  7. Fornire eventuali parametri API richiesti e fare clic su Invia.
    La risposta API viene visualizzata nella sezione Risposta .
    Nota: se si riceve un messaggio relativo a un certificato non attendibile, fare clic sul collegamento fornito, accettare il certificato, quindi tornare all'ambiente di prova e fare nuovamente clic su Invia.

Cosa fare successivamente

Quando sei soddisfatto dell'aspetto e del comportamento della tua API, puoi preparare l'API in un prodotto in un catalogo. Per ulteriori informazioni, vedi Staging an API.