Gestione dell'area di lavoro Apigee

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

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 uno spazio di lavoro Apigee.

Creazione di uno spazio di lavoro Apigee

Per creare uno spazio di lavoro Apigee:

  1. Esegui una delle seguenti azioni:

    • Fai clic su Crea spazio di lavoro Apigee nella sezione Apigee se non è aperto alcuno spazio di lavoro Apigee.

      Pulsante Crea spazio di lavoro Apigee nell'interfaccia utente

    • Seleziona Visualizza > Riquadro dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: Crea spazio di lavoro Apigee.

  2. Seleziona il tipo di spazio 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 lo spazio di lavoro Apigee.

  4. Vai alla directory in cui vuoi salvare lo spazio di lavoro Apigee. Se utilizzi la gestione del controllo del codice sorgente, seleziona una posizione nel repository del controllo del codice sorgente.

  5. Fai clic su Seleziona cartella dell'area di lavoro. Lo spazio di lavoro Apigee viene creato, archiviato nella directory locale specificata e aperto in VS Code Explorer.

  6. Fai clic sull'icona Icona Apigee in Cloud Code Cloud Code nella barra delle attività.

L'area di lavoro Apigee viene visualizzata nella sezione Apigee:

Apigee Explorer che mostra le cartelle dello spazio di lavoro Apigee, inclusi apiproxy, sharedflow, ambienti e test.

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

Apertura di uno spazio di lavoro Apigee

Per aprire uno spazio di lavoro Apigee esistente:

  1. Esegui una delle seguenti azioni:

    • Fai clic su Apri spazio di lavoro Apigee nel nodo Sviluppo locale di Apigee Explorer se non è aperto alcuno spazio di lavoro Apigee.

      Pulsante Apri area di lavoro Apigee nell'interfaccia utente

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

  2. Vai 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 apri uno spazio di lavoro con più repository, seleziona il file dello spazio 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. Lo spazio di lavoro Apigee viene aperto in Cloud Code, dove puoi esplorarne i contenuti.

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

L'area di lavoro Apigee viene visualizzata in Apigee Explorer:

Apigee Explorer che mostra le cartelle dello spazio di lavoro Apigee, inclusi apiproxy, sharedflow, ambienti e test.

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

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. Lo spazio di lavoro Apigee è archiviato in your-workspace-folder/src/main/apigee nel tuo ambiente locale.

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

Cartella Descrizione
apiproxies Contiene una cartella apiproxy-name/apiproxy separata per ogni configurazione del proxy API, strutturata come descritto nella struttura della directory di configurazione del proxy API.

Ad esempio: helloworld/apiproxy

Per ulteriori informazioni, consulta Sviluppo di proxy API.

environments Definisce i contesti di esecuzione di runtime per i proxy API e i flussi condivisi che vuoi implementare, tra cui:
  • Definizioni di deployment di proxy API e flussi condivisi
  • Risorse a livello di ambiente
  • Hook di flusso condivisi
  • Server di destinazione
  • Negozi principali

Per ulteriori informazioni, consulta Configurare e implementare gli 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 saperne di più, vedi Sviluppare 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.

Guarda questo esempio di struttura di uno spazio di lavoro Apigee nel tuo ambiente locale, dove src/main/apigee è la radice:

Struttura dello spazio di lavoro Apigee in Cloud Code

Informazioni sulla struttura di uno spazio di lavoro Apigee con più repository

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.

Uno spazio di lavoro con più repository è un file di testo JSON con estensione .code-workspace.

Questo è 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 test bundle (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"
    }
  ]
}

Questi requisiti si applicano a ogni tipo di cartella che può essere aggiunta a un'area di lavoro con più repository:

Tipo di cartella Struttura delle cartelle obbligatoria
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 nella 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 insieme di risorse di test, come descritto in Creare 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

Modifica un'area di lavoro con più repository aprendo 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.

    Pulsante Apri area di lavoro Apigee nell'interfaccia utente

  • Seleziona Visualizza > Riquadro dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: Modifica spazio 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.

Modifica dei file in uno spazio di lavoro Apigee

Per modificare un file in uno spazio di lavoro Apigee:

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

  2. Modifica il file, se necessario.

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

Copiare cartelle e file in uno spazio di lavoro Apigee

Per copiare una cartella o un file in uno spazio di lavoro Apigee:

  1. Fai clic con il tasto destro del mouse sulla cartella o sul file che vuoi copiare in Apigee Explorer 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 nello spazio di lavoro Apigee.

Ridenominare cartelle e file in uno spazio di lavoro Apigee

Per rinominare una cartella o un file in uno spazio di lavoro Apigee:

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

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

La cartella o il file viene rinominata in Apigee Explorer.

Eliminare cartelle e file da uno spazio di lavoro Apigee

Per eliminare una cartella o un file da uno spazio 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 dallo spazio 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 Icona Aggiorna per Apigee Explorer.

  • Seleziona Visualizza > Riquadro dei comandi per aprire la tavolozza dei comandi e seleziona Cloud Code: Aggiorna visualizzazione di Apigee Explorer.