Gestione dell'area di lavoro Apigee

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Nota: utilizza lo sviluppo locale con Apigee e Apigee hybrid 1.5 e versioni successive.

Prima di poter sviluppare le API Apigee in locale utilizzando Cloud Code, devi creare una nuova area di lavoro Apigee o aprirne una esistente in Cloud Code. Uno spazio di lavoro Apigee contiene la struttura di directory richiesta per lo sviluppo locale.

Le sezioni seguenti descrivono come creare, aprire e gestire un'area di lavoro Apigee.

Creazione di uno spazio di lavoro Apigee

Per creare un'area di lavoro Apigee:

1. Esegui una delle seguenti azioni:

   • Fai clic su Crea area di lavoro Apigee nella sezione Apigee se al momento non è aperta area di lavoro Apigee.

     

   • Seleziona Visualizza > Tavolozza dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: Create Apigee workspace.

2. Seleziona il tipo di area di lavoro che corrisponde al tuo stile di sviluppo preferito. Puoi scegliere tra un'area di lavoro con un repository o un'area di lavoro con più repository.

3. Inserisci un nome per l'area di lavoro Apigee.

4. Vai alla directory in cui vuoi salvare l'area di lavoro Apigee.
   Se utilizzi la gestione del controllo del codice sorgente, seleziona una posizione nel repository dei controlli del codice sorgente.

5. Fai clic su Seleziona cartella dell'area di lavoro.
   L'area di lavoro Apigee viene creata, archiviata nella directory locale specificata e aperta in Esplora VS Code.

6. Fai clic sull'icona di Cloud Code nella barra delle attività.

L'area di lavoro Apigee viene visualizzata nella sezione Apigee, come mostrato di seguito.

In base al tipo di spazio di lavoro selezionato, vengono creati i seguenti contenuti:

• Per uno spazio di lavoro con un repository singolo, viene creato un insieme di cartelle in your-workspace-location Per ulteriori informazioni, consulta Informazioni sulla struttura di uno spazio di lavoro con un repository singolo Apigee.
• Per uno spazio di lavoro con più repository, viene creato un file denominato your-workspace-location.code-workspace con i contenuti JSON richiesti. Per saperne di più, consulta Informazioni sulla struttura di un'area di lavoro con più repository Apigee.

Apertura di uno spazio di lavoro Apigee

Nota: quando apri un'area di lavoro Apigee, la struttura viene convalidata. Per saperne di più, consulta Informazioni sulla struttura di un'area di lavoro Apigee.

Per aprire uno spazio di lavoro Apigee esistente:

1. Esegui una delle seguenti azioni:

   • Fai clic su Apri area di lavoro Apigee nel nodo Sviluppo locale di Apigee Explorer se al momento non è aperta area di lavoro Apigee.

     

   • Seleziona Visualizza > Riquadro dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: apri Apigee Workspace.

2. Accedi all'area di lavoro Apigee nel tuo ambiente locale.

   • Se apri uno spazio di lavoro con un repository singolo, seleziona la cartella di primo livello dello spazio di lavoro Apigee che contiene la cartella src/main/apigee
   • Se stai aprendo un'area di lavoro con più repository, seleziona il file dell'area di lavoro con estensione .code-workspace

3. Fai clic su Seleziona la cartella dello spazio di lavoro o il file dello spazio di lavoro con più repository.
   L'area di lavoro Apigee è aperta in Cloud Code}}, dove puoi esplorare i contenuti dell'area di lavoro.

4. Fai clic sull'icona Cloud Code nella barra delle attività.

L'area di lavoro Apigee viene visualizzata in Apigee Explorer, come mostrato di seguito.

Informazioni sulla struttura di un'area di lavoro con repository singolo Apigee

Quando crei uno spazio di lavoro Apigee con un repository singolo in Apigee in Google Cloud, viene creato un insieme di cartelle che ti consente di sviluppare proxy API e flussi condivisi, configurare ed eseguire il deployment di ambienti, nonché creare ed esportare risorse di test. L'area di lavoro Apigee è archiviata in your-workspace-folder/src/main/apigee nel tuo ambiente locale.

La tabella seguente riassume la struttura di un'area di lavoro Apigee a livello generale.

Nota: quando gestisci uno spazio di lavoro Apigee al di fuori di Apigee in Cloud Code, assicurati di mantenere la struttura descritta di seguito per evitare errori di convalida.

Cartella	Descrizione
apiproxies	Contiene una cartella apiproxy-name/apiproxy separata per ogni configurazione del proxy API, strutturata come descritto nella sezione Struttura della directory di configurazione del proxy API. Ad esempio: helloworld/apiproxy Per saperne di più, consulta la sezione Sviluppo di proxy API.
environments	Definisce i contesti di esecuzione del runtime per i proxy API e i flussi condivisi di cui vuoi eseguire il deployment, tra cui: Definizioni di deployment di proxy API e flussi condivisi Risorse a livello di ambiente Hook di flusso condivisi Server di destinazione Negozi di chiavi Per saperne di più, consulta Configurazione e deployment degli ambienti.
sharedflows	Contiene una cartella sharedflow-name/sharedflowbundle separata per ogni configurazione del flusso condiviso, strutturata come descritto in Riferimento per la configurazione del bundle di flussi condivisi. Ad esempio: mysharedflow/sharedflowbundle Per ulteriori informazioni, consulta Sviluppo di flussi condivisi.
tests	Fornisce un insieme di risorse di test, come prodotti API o sviluppatori, necessarie per testare le API localmente. Per ulteriori informazioni, vedi Creare ed esportare risorse di test.

Di seguito è riportato un esempio della struttura di un'area di lavoro Apigee nel tuo ambiente locale, dove src/main/apigee è la radice.

Informazioni sulla struttura di un'area di lavoro con più repository Apigee

Uno spazio di lavoro con più repository funziona in modo simile a uno spazio di lavoro con più origini in Cloud Code. Offre agli utenti la flessibilità di scegliere singoli percorsi di archiviazione per i propri elementi, ma di svilupparli insieme utilizzando un'unica area di lavoro. Ad esempio, quando l'utente preferisce un repository di gestione del codice sorgente per proxy.

Un'area di lavoro con più repository è costituita da un file di testo JSON con estensione .code-workspace.

Di seguito è riportato un esempio di contenuti di uno spazio di lavoro con più repository che contiene due proxy API (authentication-proxy, products-proxy), un flusso condiviso (SF-threat-protection), due ambienti (dev, test) e un bundle di test (test-products).

{
  "folders": [
    {
      "name": "authentication-proxy",
      "type": "proxy",
      "path": "/work/quickdemo/multi/authentication-proxy"
    },
    {
      "name": "products-proxy",
      "type": "proxy",
      "path": "/work/quickdemo/multi/products-proxy"
    },
    {
      "name": "SF-threat-protection",
      "type": "sharedflow",
      "path": "/work/quickdemo/multi/SF-threat-protection"
    },
    {
      "name": "dev",
      "type": "environment",
      "path": "/work/quickdemo/multi/dev"
    },
    {
      "name": "test",
      "type": "environment",
      "path": "/work/quickdemo/multi/test"
    },
    {
      "name": "test-products",
      "type": "test",
      "path": "/work/quickdemo/multi/test-products"
    }
  ]
}

Di seguito sono riportati i requisiti per ogni tipo di cartella che può essere aggiunto a uno spazio di lavoro con più repository

Tipo di cartella	Struttura richiesta per le cartelle
environment	Definisce la configurazione dell'ambiente, come descritto in Configurare un ambiente. Il nome della cartella viene utilizzato come nome dell'ambiente.
proxy	Definisce la struttura del proxy API, come descritto in Struttura della directory di configurazione del proxy API. Il nome della cartella viene utilizzato come nome del proxy API.
sharedflow	Definisce il flusso condiviso con struttura, come descritto in Riferimento per la configurazione del bundle di flussi condivisi. Il nome della cartella viene utilizzato come nome del flusso condiviso.
test	Definisce un set di risorse di test, come descritto in Creazione di risorse di test.Il nome della cartella viene utilizzato come nome della risorsa di test.

Modifica di uno spazio di lavoro Apigee con più repository

Per modificare un'area di lavoro con più repository, apri il file your-workspace.code-workspace in Cloud Code o nel tuo editor preferito.

Per aprire il file dall'estensione Apigee in Cloud Code:

• Fai clic su Modifica spazio di lavoro nel nodo Sviluppo locale di Apigee Explorer.

  

• Seleziona Visualizza > Tavolozza dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: Modifica area di lavoro.

Gestione di cartelle e file in uno spazio di lavoro Apigee

Le sezioni seguenti descrivono come gestire cartelle e file in uno spazio di lavoro Apigee.

Modificare i file in un'area di lavoro Apigee

Per modificare un file in un'area di lavoro Apigee:

1. Fai clic sul nome del file che vuoi modificare in Apigee Explorer. I contenuti vengono visualizzati nell'editor.

2. Modifica il file come richiesto.

3. Seleziona File > Salva o ⌘S per salvare le modifiche.

Copia di cartelle e file in un'area di lavoro Apigee in corso...

Per copiare una cartella o un file in un'area di lavoro Apigee:

1. In Apigee Explorer, fai clic con il tasto destro del mouse sulla cartella o sul file che vuoi copiare e seleziona Copia.

2. Inserisci un nome univoco per la cartella o il file e premi Invio.

La cartella o il file copiato viene visualizzato nell'area di lavoro Apigee.

Ridenominare cartelle e file in uno spazio di lavoro Apigee

Per rinominare una cartella o un file in un'area di lavoro Apigee:

1. In Apigee Explorer, fai clic con il tasto destro del mouse sulla cartella o sul file che vuoi copiare e seleziona Rinomina.

2. Inserisci un nome univoco per la cartella o il file e premi Invio.

La cartella o il file viene rinominato in Apigee Explorer.

Eliminazione di cartelle e file da un'area di lavoro Apigee

Per eliminare una cartella o un file da un'area di lavoro Apigee, fai clic con il tasto destro del mouse sulla cartella o sul file che vuoi copiare in Apigee Explorer e seleziona Elimina. La cartella o il file viene rimosso dall'area di lavoro Apigee.

Aggiornamento della visualizzazione dell'area di lavoro Apigee

Per aggiornare la visualizzazione dello spazio di lavoro Apigee e sincronizzare le modifiche recenti apportate (eventualmente al di fuori di Cloud Code), esegui una delle seguenti azioni:

• Posiziona il cursore sulla barra del titolo di Apigee Explorer e fai clic su .

• Seleziona Visualizza > Tavolozza dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: refresh Apigee Explorer view.

Passaggi successivi

• Inizia a sviluppare i proxy API e i flussi condivisi