Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Antes de poder desenvolver as suas APIs Apigee localmente com o Cloud Code, tem de criar um novo espaço de trabalho do Apigee ou abrir um existente no Cloud Code. Um espaço de trabalho do Apigee contém a estrutura de diretórios necessária para o desenvolvimento local.
As secções seguintes descrevem como criar, abrir e gerir um espaço de trabalho do Apigee.
Criar um espaço de trabalho do Apigee
Para criar um espaço de trabalho do Apigee:
Realize uma das seguintes ações:
Clique em Criar espaço de trabalho do Apigee na secção Apigee se não estiver aberto nenhum espaço de trabalho do Apigee.
Selecione Ver > Paleta de comandos para abrir a paleta de comandos e selecione Cloud Code: Create Apigee workspace.
Selecione o tipo de espaço de trabalho que corresponde ao seu estilo de desenvolvimento preferido. Pode escolher entre um espaço de trabalho de repositório único ou um espaço de trabalho de vários repositórios.
Introduza um nome para o espaço de trabalho do Apigee.
Navegue para o diretório onde quer guardar o espaço de trabalho do Apigee. Se estiver a usar a gestão de controlo de origem, selecione uma localização no repositório de controlo de origem.
Clique em Selecionar pasta do espaço de trabalho. O espaço de trabalho do Apigee é criado, armazenado no diretório local especificado e aberto no Explorador do VS Code.
Clique no ícone
do Cloud Code na barra de atividade.
O espaço de trabalho do Apigee é apresentado na secção Apigee:
Com base no tipo de espaço de trabalho selecionado, é criado o seguinte conteúdo:
-
Para um espaço de trabalho de repositório único, é criado um conjunto de pastas em
your-workspace-location. Para mais informações, consulte o artigo Compreender a estrutura de um espaço de trabalho de repositório único do Apigee. -
Para um espaço de trabalho com vários repositórios, é criado um ficheiro denominado
your-workspace-location.code-workspacecom o conteúdo JSON necessário. Para mais informações, consulte o artigo Compreender a estrutura de um espaço de trabalho com vários repositórios do Apigee.
Abrir um espaço de trabalho do Apigee
Para abrir um espaço de trabalho do Apigee existente:
Realize uma das seguintes ações:
Clique em Abrir espaço de trabalho do Apigee no nó Desenvolvimento local do Apigee Explorer se não estiver aberto nenhum espaço de trabalho do Apigee.
Selecione Ver > Paleta de comandos para abrir a paleta de comandos e selecione Cloud Code: Open Apigee Workspace.
Navegue para o espaço de trabalho do Apigee no seu ambiente local.
- Se estiver a abrir um espaço de trabalho de repositório único, selecione a pasta de nível superior do seu espaço de trabalho do Apigee que contém a pasta
src/main/apigee. - Se estiver a abrir um espaço de trabalho com vários repositórios, selecione o ficheiro do espaço de trabalho com a extensão
.code-workspace.
- Se estiver a abrir um espaço de trabalho de repositório único, selecione a pasta de nível superior do seu espaço de trabalho do Apigee que contém a pasta
Clique em Selecionar pasta do espaço de trabalho ou ficheiro do espaço de trabalho com vários repositórios. O espaço de trabalho do Apigee é aberto no Cloud Code, onde pode explorar o conteúdo do espaço de trabalho.
Clique no ícone
do Cloud Code na barra de atividade.
O espaço de trabalho do Apigee é apresentado no Apigee Explorer:
Compreender a estrutura de um espaço de trabalho de repositório único do Apigee
Quando cria um espaço de trabalho do Apigee de repositório único no Apigee in Google Cloud, é criado um conjunto de pastas que lhe permite desenvolver proxies de API e fluxos partilhados, configurar e implementar ambientes, bem como criar e exportar recursos de teste. O espaço de trabalho do Apigee é armazenado em your-workspace-folder/src/main/apigee no seu ambiente local.
A tabela seguinte resume a estrutura de um espaço de trabalho do Apigee a um nível elevado.
| Pasta | Descrição |
|---|---|
apiproxies
|
Contém uma pasta apiproxy-name/apiproxy separada para cada configuração de proxy de API, estruturada conforme descrito em Estrutura do diretório de configuração do proxy de API.
Por exemplo: Para mais informações, consulte o artigo Desenvolver proxies de API. |
environments
|
Define os contextos de execução de tempo de execução para os proxies de API e os fluxos partilhados que quer implementar, incluindo:
Para mais informações, consulte o artigo Configurar e implementar ambientes. |
sharedflows
|
Contém uma pasta sharedflow-name/sharedflowbundle separada para cada configuração de fluxo partilhado, estruturada conforme descrito na referência de configuração do pacote de fluxo partilhado.
Por exemplo: Para mais informações, consulte o artigo Desenvolver fluxos partilhados. |
tests
|
Fornece um conjunto de recursos de teste, como produtos API ou programadores, necessários para testar as suas APIs localmente.
Para mais informações, consulte o artigo Crie e exporte recursos de teste. |
Veja este exemplo da estrutura de um espaço de trabalho do Apigee no seu ambiente local, onde
src/main/apigee é a raiz:
Compreender a estrutura de um espaço de trabalho de vários repositórios do Apigee
Um espaço de trabalho com vários repositórios funciona de forma semelhante a um espaço de trabalho com várias raízes no Cloud Code. Oferece aos utilizadores flexibilidade para escolherem localizações de armazenamento individuais para os respetivos artefactos, mas desenvolvê-los em conjunto através de um único espaço de trabalho. Por exemplo, quando o utilizador prefere um repositório de gestão de código fonte por proxy.
Um espaço de trabalho com vários repositórios é um ficheiro de texto JSON com uma extensão .code-workspace.
Este é um exemplo do conteúdo de um espaço de trabalho com vários repositórios que contém dois proxies de API (authentication-proxy e products-proxy), um fluxo partilhado (SF-threat-protection), dois ambientes (dev e test) e um pacote de teste (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"
}
]
}Estes requisitos aplicam-se a cada tipo de pasta que pode ser adicionada a um espaço de trabalho com vários repositórios:
| Tipo de pasta | Estrutura de pastas necessária |
|---|---|
environment |
Define a configuração do ambiente, conforme descrito em Configurar um ambiente. O nome da pasta é usado como o nome do ambiente. |
proxy |
Define a estrutura do proxy de API, conforme descrito em Estrutura do diretório de configuração do proxy de API. O nome da pasta é usado como o nome do proxy de API. |
sharedflow |
Define o fluxo partilhado com estrutura, conforme descrito na referência de configuração do pacote de fluxo partilhado. O nome da pasta é usado como o nome do fluxo partilhado. |
test |
Define um conjunto de recursos de teste, conforme descrito em Criar recursos de teste.O nome da pasta é usado como o nome do recurso de teste. |
Editar um espaço de trabalho de vários repositórios do Apigee
Edite um espaço de trabalho com vários repositórios abrindo o ficheiro your-workspace.code-workspace no Cloud Code ou no seu editor preferido.
Para abrir o ficheiro a partir da extensão Apigee no Cloud Code:
Clique em Editar espaço de trabalho no nó Desenvolvimento local do Apigee Explorer.
Selecione Ver > Paleta de comandos para abrir a paleta de comandos e selecione Cloud Code: Editar espaço de trabalho.
Gerir pastas e ficheiros num espaço de trabalho do Apigee
As secções seguintes descrevem como gerir pastas e ficheiros num espaço de trabalho do Apigee.
Editar ficheiros num espaço de trabalho do Apigee
Para editar um ficheiro num espaço de trabalho do Apigee:
Clique no nome do ficheiro que quer editar no Apigee Explorer. Os conteúdos são apresentados no editor.
Edite o ficheiro conforme necessário.
Selecione Ficheiro > Guardar ou ⌘S para guardar as edições.
Copiar pastas e ficheiros num espaço de trabalho do Apigee
Para copiar uma pasta ou um ficheiro num espaço de trabalho do Apigee:
Clique com o botão direito do rato na pasta ou no ficheiro que quer copiar no Apigee Explorer e selecione Copiar.
Introduza um nome exclusivo para a pasta ou o ficheiro e prima Enter.
A pasta ou o ficheiro copiado aparece no espaço de trabalho do Apigee.
Mudar o nome de pastas e ficheiros num espaço de trabalho do Apigee
Para mudar o nome de uma pasta ou um ficheiro num espaço de trabalho do Apigee:
Clique com o botão direito do rato na pasta ou no ficheiro que quer copiar no Apigee Explorer e selecione Mudar o nome.
Introduza um nome exclusivo para a pasta ou o ficheiro e prima Enter.
O nome da pasta ou do ficheiro é mudado no Apigee Explorer.
Eliminar pastas e ficheiros de um espaço de trabalho do Apigee
Para eliminar uma pasta ou um ficheiro de um espaço de trabalho do Apigee, clique com o botão direito do rato na pasta ou no ficheiro que quer copiar no Apigee Explorer e selecione Eliminar. A pasta ou o ficheiro é removido do espaço de trabalho do Apigee.
Atualizar a vista do espaço de trabalho do Apigee
Para atualizar a vista do espaço de trabalho do Apigee e sincronizar as alterações recentes feitas (possivelmente fora do Cloud Code), realize uma das seguintes ações:
Posicione o cursor sobre a barra de título do Apigee Explorer e clique em
.Selecione Ver > Paleta de comandos para abrir a paleta de comandos e selecione Cloud Code: Atualizar vista do Apigee Explorer.