Creazione di un'API proxy REST da un servizio OpenAPI esistente

Modifica online

Se disponi già di un servizio di destinazione descritto in OpenAPI che desideri rendere accessibile tramite una definizione API IBM® API Connect, puoi creare un'API proxy e specificare l'endpoint di destinazione.

Informazioni su questa attività

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

Per completare questa attività, è necessario disporre di un ruolo con le autorizzazioni Api-Drafts:Edit, Settings:Viewe App:View . 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.

Crea le API REST proxy in pochi minuti utilizzando lo strumento API Designer per creare un'API da un OpenAPI OpenAPIesistente. Questa procedura crea un proxy REST che instrada tutto il traffico a un'API REST di destinazione o a un endpoint del servizio.

Procedura

Per comporre un'API proxy da un servizio OpenAPI esistente, completa la seguente 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. Selezionare Dal servizio OpenAPI esistentee fare clic su Avanti
  4. Per caricare le informazioni sul servizio da un file OpenAPI , puoi trascinare e rilasciare il tuo file oppure sfogliare e selezionare il file che vuoi utilizzare. I tipi di file validi sono YAML, YML, ecc.
    • Fare clic su Sfoglia e ricercare il file OpenAPI .
    • Trascinare e rilasciare il file nell'area attiva.
    Dopo aver caricato il file, viene valutata la specifica OpenAPI e viene visualizzato un messaggio che indica se è valida.
  5. Fare clic su Avanti. Specifica il Riepilogo API nella sezione Info . È possibile ottimizzare l'API una volta creata.
    • Il Titolo può includere caratteri speciali, ma deve essere breve in modo che possa essere facilmente visualizzato nell'interfaccia utente.
    • Il nome viene immesso automaticamente. Il valore nel campo Nome è una stringa singola utilizzata per identificare l'API nei comandi CLI developer toolkit . Per visualizzare i comandi CLI per la gestione delle API in bozza, consultare la documentazione di riferimento della CLI del toolkit.
    • La Versione corrisponde al valore della proprietà info.version della definizione OpenAPI dell'API. Si consiglia di utilizzare lo schema di numerazione della versione version.release.modification , ad esempio 1.0.0.
    • Il percorso base è il segmento dell'API ( URL ) e non include il nome host o eventuali segmenti aggiuntivi per percorsi o operazioni. Il percorso di base non può includere caratteri speciali e deve iniziare con un carattere / anche se è altrimenti vuoto.
    • La Descrizione facoltativa consente di identificare l'API.
  6. Fare clic su Avanti. Nella sezione Secure , configurare la sicurezza API di cui si ha bisogno.
    • Protezione mediante ID client : selezionare questa opzione per richiedere a un'applicazione di fornire un ID client (chiave API). Ciò fa sì che il parametro X-IBM-Client-Id venga incluso nell'intestazione della richiesta per l'API. Se selezionato, puoi quindi scegliere se limitare le chiamate API in base alla chiave (per ID client):
      • Limita chiamate API in base alla chiave - Se selezionato, è necessario configurare il limite di frequenza richiesto. I limiti di frequenza controllano il numero massimo di chiamate consentite in un periodo di tempo (ora, minuto, mese o giorno). Ad esempio, 100 chiamate all'ora.
    • CORS - Seleziona questa opzione per abilitare il supporto CORS () per la tua API. Ciò consente l'accesso alla tua API da un altro dominio.
      Nota:
      • CORS L'assistenza è disponibile solo su DataPower® API Gateway.
      • Quando CORS è abilitato, l' API Gateway e esegue la cors politica di preflusso per gestire tutte le richieste CORS effettuate all'API.
      • Quando l'opzione " CORS " è abilitata e viene ricevuta una richiesta di preflight, vengono eseguite solo le seguenti azioni API:
        • La politica di preflusso cors configura le intestazioni di risposta appropriate.
        • Le intestazioni di risposta sono impostate.
      • Quando viene ricevuta una richiesta preflight, l'indicatore request.attributes.isCORSPreflight è impostato su true.
      • Per tutte le richieste preflight, le security politiche e client-identification preflow vengono sempre ignorate, indipendentemente dal fatto che l'opzione " CORS " sia abilitata o meno.
  7. 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 Connect 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.
  8. Fare clic su Avanti per creare la definizione API.

    Il pannello Riepilogo visualizza i messaggi quando viene creata la definizione e le opzioni di sicurezza e i limiti di velocità selezionati vengono applicati.

    Se hai selezionato Attiva API, la procedura guidata popola un endpoint API ( URL ) che puoi utilizzare nei test. Se è stato selezionato anche Proteggi utilizzando l'ID client, la procedura guidata visualizza un ID client e un segreto client che è possibile utilizzare.

  9. 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.

Risultati

Hai creato un'API proxy da un servizio OpenAPI esistente.

Cosa fare successivamente

Le API vengono messe a disposizione degli sviluppatori di applicazioni includendo tali API in un prodotto e pubblicando tale prodotto in un catalogo. Per ulteriori informazioni, consultare le sezioni "Utilizzo dei prodotti" e "Utilizzo dei cataloghi".