Importazione di un'API dal repository di asset CP4I

Modifica online

Se stai utilizzando API ConnectAI Gateway con IBM® Cloud Pak for Integration, puoi importare una definizione API dal repository di asset CP4I .

Informazioni su questa attività

Per completare questa attività, è necessario disporre di un ruolo con autorizzazione Api-Drafts:Edit . Il ruolo "Sviluppatore" dispone di questa autorizzazione per impostazione predefinita; se ti viene assegnato un ruolo personalizzato, questo deve includere tale autorizzazione. Per ulteriori informazioni, consultare Creazione di ruoli personalizzati.

Procedura

  1. Nel riquadro di navigazione, fare clic su Icona di sviluppo nel riquadro di navigazione dell'interfaccia utente API Sviluppo, quindi su Aggiungi > API.
    Viene visualizzata la schermata Seleziona tipo API .
  2. Seleziona OpenAPI 2.0 o OpenAPI 3.0 in base a quale versione della specifica OpenAPI deve essere basata la tua API.
  3. Nella sezione Importa, selezionare Da repository asset, quindi fare clic su Avanti
  4. Fare clic su Avvia repository asset.
  5. Dall'elenco di repository di asset, fare clic sul nome dell'API che si desidera importare.
    Si apre una finestra Esplora API, che consente di esaminare i dettagli dell'API.
  6. Fare clic su Crea da asset.
    La validità della definizione API viene controllata e viene visualizzato un messaggio che indica una corretta convalida.
  7. Fare clic su Avanti.
  8. Opzionale: selezionare Attiva API se si desidera utilizzare immediatamente l'API per ulteriori sviluppi e test.
    Nota:
    • Quando si seleziona l'opzione Attiva API , API ConnectAI Gateway completa automaticamente le seguenti azioni:
      • Crea una bozza del prodotto, aggiunge l'API al prodotto e pubblica il prodotto nel catalogo Sandbox in modo che l'API sia disponibile per essere richiamata. Il prodotto ha il titolo "api_title auto product". Questo prodotto non è visibile nella vista "Sviluppo" e non è possibile eliminarlo direttamente. Tuttavia, se si elimina l'API, anche la bozza del prodotto viene eliminata insieme all'API; vedere Eliminazione di una definizione API. Il prodotto è visibile in tutti i cataloghi in cui è stato pubblicato. Se desideri rimuovere il prodotto da un catalogo, devi procedere separatamente; consulta la sezione "Rimozione di un prodotto da un catalogo"
      • Associa l'applicazione di prova Sandbox al prodotto, in modo da poter testare immediatamente l'API nell'ambiente di prova. Per informazioni sulla verifica di un'API, consultare Verifica di un'API.
    • Non è possibile utilizzare l'opzione "Attiva API " se nel catalogo Sandbox è abilitata l'approvazione del ciclo di vita per le azioni "Stage", "Pubblica" o "Sostituisci". Se sono attive approvazioni del ciclo di vita di questo tipo, per poter utilizzare l'opzione API di attivazione è necessario disattivarle; per informazioni sulle impostazioni relative alle approvazioni del ciclo di vita, consultare la sezione Creazione e configurazione dei cataloghi.
    • Per utilizzare l'opzione Attiva l'API , è necessario disporre di un ruolo con autorizzazioni Product:Manage e Subscription:Manage . Il ruolo di sviluppatore fornito in precedenza ha queste autorizzazioni per impostazione predefinita; se ti viene assegnato un ruolo personalizzato, deve disporre di queste autorizzazioni. Per ulteriori informazioni, consultare Creazione di ruoli personalizzati.
  9. Fare clic su Avanti.
    Il pannello Riepilogo visualizza i messaggi quando viene creata la definizione API.
  10. Selezionare una delle seguenti opzioni:
    • Per configurare ulteriormente la tua API, fai clic su Modifica API. Per i dettagli, consultare Modifica di una definizione API.
    • Se non vuoi configurare ulteriormente la tua API in questo momento, fai clic sul collegamento Develop nella traccia di navigazione per tornare alla pagina di benvenuto; puoi quindi passare immediatamente ad un'altra attività. Per i dettagli su come configurare la tua API successivamente, vedi Modifica di una definizione API.