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 tue API Apigee localmente utilizzando Cloud Code, devi creare un'area di lavoro Apigee nuova o aperta in Cloud Code. Un'area di lavoro Apigee contiene la struttura di directory necessaria per lo sviluppo locale.

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

Creazione di un'area di lavoro Apigee in corso...

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 nessuna area di lavoro Apigee è aperta.

      Pulsante Crea area di lavoro Apigee nella UI

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

  2. Seleziona il tipo di area di lavoro che corrisponde al tuo stile di sviluppo preferito. Puoi scegliere tra un'area di lavoro con singolo repository o un'area di lavoro multi-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 località nel tuo repository di controllo del codice sorgente.

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

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

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

Apigee Explorer che mostra le cartelle dell'area di lavoro Apigee, inclusi APIproxies, flussi condivisi, ambienti e test.

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

Apertura di un'area di lavoro Apigee in corso...

Per aprire un'area 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 alcuna area di lavoro Apigee.

      Pulsante Apri area di lavoro Apigee nella UI

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

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

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

  3. Fai clic su Seleziona la cartella dell'area di lavoro o il file dell'area di lavoro multi-repository.
    L'area di lavoro di Apigee viene aperta in Cloud Code}}, dove puoi esplorarne i contenuti.

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

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

Apigee Explorer che mostra le cartelle dell'area di lavoro Apigee, inclusi APIproxies, flussi condivisi, ambienti e test.

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

Quando crei un'area di lavoro Apigee con repository singolo in Apigee in Google Cloud, viene creato un set di cartelle per consentirti di sviluppare proxy API e flussi condivisi, configurare ed eseguire il deployment di ambienti e 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 a livello generale la struttura di un'area di lavoro Apigee.

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 l'articolo 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 del proxy API e dei flussi condivisi
  • Risorse a livello di ambiente
  • Hook di flusso condivisi
  • Server di destinazione
  • Negozi di chiavi

Per ulteriori informazioni, 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, vedi Sviluppo di flussi condivisi.
tests Fornisce un insieme di risorse di test, ad esempio sviluppatori o prodotti API, necessarie per testare le API a livello locale.

Per saperne di più, consulta Creazione ed esportazione di 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.

Struttura dell'area di lavoro Apigee

Informazioni sulla struttura di un'area di lavoro multi-repository Apigee

Un'area di lavoro multi-repository funziona in modo simile a un'area di lavoro multi-root in Cloud Code. Offre agli utenti la flessibilità di scegliere singole posizioni di archiviazione per i propri elementi, ma di svilupparli insieme utilizzando un'unica area di lavoro. Ad esempio, quando un utente preferisce un repository di gestione del codice sorgente per proxy.

Un'area di lavoro multi-repository è un file di testo JSON con estensione .code-workspace.

Di seguito è riportato un contenuto di esempio di un'area di lavoro multi-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 (prodotti-test). 

{
  "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 aggiunta a un'area di lavoro multi-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 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 la 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 Creazione di risorse di test.Il nome della cartella viene utilizzato come nome della risorsa di test.

Modifica di un'area di lavoro multi-repository Apigee

Modifica un'area di lavoro multi-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 area di lavoro nel nodo Sviluppo locale di Apigee Explorer.

    Pulsante Apri area di lavoro Apigee nella UI

  • 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 un'area di lavoro Apigee

Le sezioni seguenti descrivono come gestire cartelle e file in un'area di lavoro Apigee.

Modifica dei 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 necessario.

  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. Fai clic con il pulsante 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 vengono visualizzati nell'area di lavoro Apigee.

Ridenominazione di cartelle e file in un'area di lavoro Apigee

Per rinominare una cartella o un file in un'area 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 vengono rinominati 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 di Apigee

Per aggiornare la visualizzazione dell'area di lavoro di Apigee e sincronizzare le modifiche apportate di recente (possibilmente 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.

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

Passaggi successivi