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

Se si dispone di un servizio SOAP definito in un file WSDL , è possibile utilizzare il file WSDL per creare un'API proxy REST API Connect che richiama tale servizio SOAP.

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.

Se il file WSDL è un file autonomo senza dipendenze esterne, è possibile caricare il file .wsdl da una directory per creare la definizione dell'API REST.

Se il file WSDL fa riferimento ad altri file WSDL o fa riferimento a file XSD contenenti definizioni di schemi XML, è necessario creare un archivio .zip del file WSDL e dei relativi documenti dipendenti, quindi caricare il file .zip da una directory per aggiungere la definizione API REST.

Procedura

Per aggiungere una definizione API REST caricando un file WSDL , completare la seguente procedura:

  1. Nel riquadro di navigazione, fare clic su Icona di sviluppo nel riquadro di navigazione dell'interfaccia utente API Develop, quindi su Add > API.
    Viene visualizzata la schermata Seleziona tipo API .
  2. Selezionare OpenAPI 2.0.
  3. Nel riquadro Aggiungi API, selezionare Da servizio WSDL esistente (proxy REST). Fare clic sul pulsante Avanti.
    Viene visualizzata la finestra Crea API da servizio WSDL esistente (proxy REST) .
  4. Per caricare le informazioni di servizio da un file .wsdl autonomo o da un file .zip contenente un file WSDL e i relativi documenti dipendenti, è possibile trascinare e rilasciare il proprio file oppure sfogliare e selezionare il file che si desidera utilizzare.

    Dopo aver caricato il file, il WSDL viene valutato e un messaggio visualizza se il WSDL è valido.

    Se si carica un file .zip , è possibile includere nel file .zip un file di opzioni per specificare ulteriori direttive. Per ulteriori informazioni, vedere Utilizzo di un file di opzioni durante l'importazione di un servizio WSDL.

  5. Fare clic su Avanti. Sul pannello Seleziona servizio, selezionare un servizio WSDL dal file importato
  6. 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 bozze di API, consultare il sito documentazione di riferimento del toolkit CLI.
    • 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 di base è il segmento dell' URL dell'API e non include il nome dell'host o altri segmenti per i percorsi o le 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.
  7. 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 (cross-origin resource sharing) per la tua API. Ciò consente l'accesso alla tua API da un altro dominio.
      Nota:
      • Il supporto CORS è disponibile solo su DataPower® API Gateway.
      • Quando CORS è abilitato, il API Gateway esegue la politica di preflusso cors per gestire tutte le richieste CORS effettuate all'API.
      • Quando CORS è abilitato e viene ricevuta una richiesta preflight, vengono eseguite solo le azioni API riportate di seguito:
        • 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 politiche di preflusso security e client-identification vengono sempre ignorate, indipendentemente dal fatto che CORS sia abilitato o meno.
  8. Facoltativo: selezionare Attiva API se si desidera utilizzare immediatamente l'API per ulteriori attività di sviluppo e test.
    Nota:
    • Quando si seleziona l'opzione Attiva API , API Connect completa automaticamente le seguenti azioni:
      • Crea una bozza di 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, la bozza del prodotto viene eliminata insieme all'API; vedere Eliminazione di una definizione API. Il prodotto è visibile in tutti i cataloghi in cui è pubblicato. Se si desidera rimuovere il prodotto da un catalogo, è necessario farlo separatamente; vedere Rimozione di un prodotto da un catalogo
      • Sottoscrive l'applicazione di test Sandbox al prodotto, in modo da poter testare immediatamente l'API nell'ambiente di test. Per informazioni sulla verifica di un'API, consultare Verifica di un'API.
    • Non è possibile utilizzare l'opzione Attiva API se l'approvazione del ciclo di vita è abilitata nel catalogo Sandbox per le azioni Stage, Publish o Replace. Se tali approvazioni del ciclo di vita sono abilitate, per poter utilizzare l'opzione Attiva API devono essere disabilitate; per informazioni sulle impostazioni dell'approvazione del ciclo di vita, vedere 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 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 si è selezionata l'opzione Attiva API, la procedura guidata inserisce un URL dell'endpoint API che può essere utilizzato per i test. Se è stato selezionato anche Proteggi utilizzando l'ID client, la procedura guidata visualizza un ID client e un segreto client che è possibile utilizzare.

  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.

Risultati

È stata creata una definizione di API REST utilizzando un file WSDL 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, vedere Lavorare con i prodotti e Lavorare con i cataloghi.

È inoltre possibile gestire il ciclo di vita del prodotto e controllare chi può vedere e sottoscrivere il prodotto, aprendo il catalogo Sandbox associato all'API nella pagina Icona Gestisci nel riquadro di navigazione dell'interfaccia utente di API Designer Manage dell' API Designer UI.