Creazione di una risorsa API con una descrizione API

• Console
• CLI
• API

• 1. Aprire il menu di navigazione e fare clic su Servizi per sviluppatori. In Gestione API, fare clic su API.
  2. Selezionare un compartimento in cui si dispone dell'autorizzazione per utilizzare.

  3. Fare clic su Crea API, quindi specificare i valori riportati di seguito per la risorsa API.

     • Nome: il nome della risorsa API. Evitare di fornire informazioni riservate.
     • Compartimento: compartimento in cui creare la risorsa API.
     • Carica file di descrizione API: (facoltativo) file che contiene la descrizione API (in una lingua supportata) da caricare e da cui creare la descrizione API. La dimensione del file non può superare 1 MB. Il file viene analizzato per confermare che è in una lingua supportata e formattato correttamente. Attualmente, sono supportati i file OpenAPI Specification versione 2.0 (precedentemente Swagger Specification 2.0) e versione 3.0.
     • Mostra opzioni avanzate: selezionare questa opzione per applicare le tag alla risorsa. Se si dispone delle autorizzazioni per creare una risorsa, si dispone anche delle autorizzazioni per applicare tag in formato libero a tale risorsa. Per applicare una tag definita, è necessario disporre delle autorizzazioni per utilizzare lo spazio di nomi tag. Per ulteriori informazioni sull'applicazione di tag, vedere Tag delle risorse. Se non si è certi di applicare le tag, saltare questa opzione o chiedere a un amministratore. È possibile applicare le tag in un secondo momento.

  4. Fare clic su Crea API per creare la risorsa API.

     Se è stato caricato un file di descrizione API, viene creata e convalidata una descrizione API. La convalida della descrizione dell'API può richiedere alcuni minuti. Durante la convalida, la descrizione dell'API viene visualizzata con lo stato Convalida nella pagina Convalide. Quando la descrizione dell'API è stata convalidata correttamente, si verificano le seguenti azioni:

     • Nella pagina Convalide viene visualizzata la convalida riuscita.
     • La pagina Descrizione API mostra la descrizione API creata dal file di descrizione API.
     • Nella pagina Specifica distribuzione API vengono visualizzate ulteriori informazioni sulla specifica di distribuzione API predefinita creata dalla descrizione dell'interfaccia API.

     Tenere presente che, anziché creare immediatamente la risorsa API, è possibile crearla in un secondo momento utilizzando Resource Manager e Terraform. Fare clic su Salva come stack per salvare la definizione della risorsa come configurazione Terraform. Per ulteriori informazioni sul salvataggio degli stack dalle definizioni delle risorse, vedere Creazione di uno stack da una pagina di creazione delle risorse.

  5. Se la descrizione dell'API è stata visualizzata come valida per più di alcuni minuti (o se l'operazione di convalida della descrizione dell'API non è riuscita), attenersi alla procedura riportata di seguito.

     1. Fare clic su Richieste di lavoro per visualizzare una panoramica dell'operazione di convalida della descrizione dell'API.
     2. Fare clic sull'operazione Convalida API per visualizzare ulteriori informazioni sull'operazione, inclusi i messaggi di errore, i messaggi di log e lo stato delle risorse associate.
     3. Se l'operazione di convalida della descrizione API non è riuscita e non è possibile diagnosticare la causa del problema dalle informazioni sulla richiesta di lavoro, vedere Risoluzione dei problemi del gateway API.

  6. Se al momento della creazione della risorsa API non è stato caricato un file di descrizione API oppure se successivamente si desidera caricare un file di descrizione API diverso, attenersi alla procedura riportata di seguito.

     1. Nella pagina API, selezionare Modifica dal menu Azioni () per la risorsa API.
     2. Fornire i dettagli del file di descrizione dell'API da cui creare la descrizione dell'API.

  Dopo aver creato una risorsa API con una descrizione API, è possibile distribuirla in un gateway API. Vedere Utilizzo della console per creare una distribuzione API da una risorsa API.

• Per creare una risorsa API utilizzando l'interfaccia CLI, effettuare le operazioni riportate di seguito.

  1. Configurare l'ambiente client per l'uso dell'interfaccia CLI (Configuring Your Client Environment to use the CLI for API Gateway Development).
  2. Aprire un prompt dei comandi ed eseguire oci api-gateway api create per creare la risorsa API:

     oci api-gateway api create --display-name "<api-name>" --compartment-id <compartment-ocid> --content "<api-description>"

     dove:

     • <api-name> è il nome della nuova risorsa API. Evitare di fornire informazioni riservate.
     • <compartment-ocid> è l'OCID del compartimento a cui apparterrà la nuova risorsa API.
     • <api-description> è facoltativamente una descrizione API (in una lingua supportata). Il valore specificato per <api-description> può essere:
       • L'intera descrizione API, racchiusa tra virgolette. All'interno della descrizione, ogni virgoletta deve essere preceduta da una barra rovesciata (\). Ad esempio (e abbreviato per leggibilità), --content "swagger:\"2.0\",title:\"Sample API\",..."
       • Nome e posizione di un file di descrizione API, racchiuso tra virgolette e nel formato "$(< <path>/<filename>.yaml)". Ad esempio, --content "$(< /users/jdoe/api.yaml)"
       La descrizione viene analizzata per confermare che è in una lingua supportata e formattata correttamente. Attualmente, sono supportati i file OpenAPI Specification versione 2.0 (precedentemente Swagger Specification 2.0) e versione 3.0.

     Ad esempio:

     oci api-gateway api create --display-name "Hello World API Resource" --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --content "swagger:\"2.0\",title:\"Sample API\",..."

     La risposta al comando include quanto riportato di seguito.

     • OCID della risorsa API.
     • Stato del ciclo di vita (ad esempio, SUCCEEDED, FAILED).
     • ID della richiesta di lavoro per creare la risorsa API (i dettagli delle richieste di lavoro sono disponibili per sette giorni dopo il completamento, l'annullamento o l'errore).

     Se si desidera che il comando attenda la restituzione del controllo fino a quando la risorsa API non è stata creata (o la richiesta non è riuscita), includere uno o entrambi i seguenti parametri:

     • --wait-for-state SUCCEEDED
     • --wait-for-state FAILED

     Ad esempio:

     oci api-gateway api create --display-name "Hello World API Resource" --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --content "swagger:\"2.0\",title:\"Sample API\",..." --wait-for-state SUCCEEDED

     Tenere presente che non è possibile utilizzare la risorsa API finché la richiesta di lavoro non la ha creata correttamente.

  3. (Facoltativo) Per visualizzare lo stato della richiesta di lavoro che sta creando la risorsa API, immettere:

     oci api-gateway work-request get --work-request-id <work-request-ocid>

  4. (Facoltativo) Per visualizzare i log della richiesta di lavoro che sta creando la risorsa API, immettere:

     oci api-gateway work-request-log list --work-request-id <work-request-ocid>

  5. (Facoltativo) Se la richiesta di lavoro che sta creando la risorsa API non riesce e si desidera esaminare i log degli errori, immettere:

     oci api-gateway work-request-error --work-request-id <work-request-ocid>

  Per ulteriori informazioni sull'uso dell'interfaccia CLI, vedere Command Line Interface (CLI, interfaccia a riga di comando). Per un elenco completo dei flag e delle opzioni disponibili per i comandi della CLI, vedere la Guida della CLI.

• Eseguire l'operazione CreateAPI per creare una risorsa API.