Specifica delle impostazioni del gateway e del portale

Definire le impostazioni di configurazione generali per la propria API.

Informazioni su questa attività

Nota: questa attività fa riferimento alla configurazione di una definizione API OpenAPI 2.0 . Per i dettagli su come configurare una definizione API OpenAPI 3.0 , vedi Modifica di una definizione API OpenAPI 3.0.

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

In qualsiasi momento, puoi passare direttamente all'origine YAML OpenAPI sottostante facendo clic sull'icona Origine Icona origine OpenAPI. Per tornare al modulo di progettazione, fare clic su Modulo Icona modulo.

Procedura

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 2.0.
  2. Selezionare la scheda Gateway e fare clic su Impostazioni gateway e portale.
  3. Immettere le seguenti informazioni:
    • Servizi di destinazione: definire i servizi web che si desidera utilizzare nella definizione API. Per i dettagli, vedi Definizione dei servizi di destinazione per un'API.
    • Applicato: selezionare questa opzione per applicare l'API utilizzando DataPower® API Gateway. Deselezionare questa opzione se si sta gestendo l'API su un gateway diverso da DataPower API Gateway. Anche se non è stato pubblicato su un gateway da API Connect, un'API non applicata è ancora disponibile in Developer Portal per la sottoscrizione da parte degli sviluppatori dell'applicazione.
    • Phase: la fase del ciclo di vita in cui si trova la tua API; seleziona una delle seguenti opzioni:
      • Realizzato (predefinito) - L'API è in fase di implementazione
      • Identificato - L'API è nella fase concettuale iniziale e non è né completamente progettata né implementata.
      • Specificato - L'API è stata completamente progettata e ha superato un punto cardine interno ma non è stata ancora implementata.
    • Testabile: seleziona questa opzione per consentire il test delle operazioni dell'API utilizzando lo strumento di verifica in Developer Portal.
      Nota: perché lo strumento di test funzioni, un'API deve essere inclusa in un piano in un prodotto che viene preparato in un catalogo.
    • CORS: abilita e configura il supporto CORS (cross-origin resource sharing) per la tua API. Per i dettagli, vedi Abilitazione del supporto CORS per un'API.
    • Proprietà: aggiungere le proprietà a cui è possibile fare riferimento nella definizione API. Per i dettagli, vedi Impostazione delle proprietà API.
    • Proprietà catalogo: definire i valori delle proprietà specifici di un particolare Catalogo. Per i dettagli, consultare Definizione dei valori di proprietà specifici del Catalogo.
    • Gateway: per i dettagli, vedi Specifica del tipo di gateway per una definizione API.
    • Autenticazione applicazione: abilita l'autenticazione dell'applicazione per proteggere la tua API con un certificato. Per i dettagli, consultare Configurazione dell'autenticazione dell'applicazione per una API.
    • Origine autenticazione applicazione: Se l'autenticazione dell'applicazione è abilitata, specificare in che modo il certificato client viene inviato al gateway. Per i dettagli, consultare Configurazione dell'autenticazione dell'applicazione per una API.
    • Registro attività: Configurare le preferenze di registrazione per l'attività API memorizzata in analytics. Per i dettagli, consultare Configurazione della registrazione attività.
    • Compatibilità: per i dettagli, consulta Configurazione delle opzioni di compatibilità v5.
    • Pagina Html: per un'API GraphQL , la pagina HTML con cui l'API risponde a una richiesta iniziale dell'editor GraphiQL . Attualmente, l'unica opzione è store:///graphiql.html. Per ulteriori informazioni, consultare Abilitazione dell'editor GraphiQL per un'API GraphQL.
    • Schema grafico: per un'API GraphQL , il nome della definizione dello schema che fa riferimento allo schema GraphQL importato. Per informazioni sul caricamento di uno schema durante la creazione dell'API GraphQL , consultare Creazione di un'API proxy GraphQL. Per informazioni sulla sostituzione dello schema per un'API GraphQL , consultare Utilizzo dell'editor di schema GraphQL.
    • Estensioni: estensioni aggiunte all'API per estendere la specifica OpenAPI . Per i dettagli, vedi Aggiunta di una estensione OpenAPI a una API.