Projetar e editar APIs

Esta página se aplica a Apigee e à Apigee híbrida.

Confira Apigee Edge documentação.

Esta página fornece instruções sobre como criar e editar APIs na Apigee no Cloud Code.

Antes de começar

Antes de usar a funcionalidade neste guia, siga as etapas de configuração em Como configurar o gerenciamento de APIs da Apigee no Cloud Code para VS Code, incluindo a verificação se a conta de usuário tem os papéis necessários listados em Papéis necessários para usar o hub de APIs da Apigee com o desenvolvimento local da Apigee.

Projete APIs

É possível adicionar e editar proxies de API da Apigee e APIs do hub de APIs diretamente no Cloud Code.

• Crie um proxy de API da Apigee seguindo as etapas em Criar um proxy de API.
• Crie uma API do hub de APIs clicando no ícone de adição na linha do host do hub de APIs. Isso abre uma janela de edição de especificação e um painel do Swagger para a nova especificação de API e permite publicar a API no hub de APIs.

Dica: também é possível usar o chat do Gemini Code Assist para criar uma especificação OpenAPI e copiá-la para uso na Apigee. Para mais informações, consulte Programar com o Gemini Code Assist Standard e Enterprise. Após a configuração, insira um comando como

Create an OpenAPI spec for an API that lets customers schedule appointments with a dental office.

As especificações geradas dessa forma não incorporam o contexto empresarial do hub de APIs.

Editar APIs

É possível editar APIs salvas localmente ou no catálogo do hub de APIs. As alterações feitas no Cloud Code podem ser publicadas no hub de APIs ou salvas como um pacote de proxy de API da Apigee.

Independentemente do método usado para editar uma API, é possível atualizar a especificação manualmente ou usar o chat do Gemini Code Assist (se ativado) para iterar na especificação. Ao usar o chat do Gemini Code Assist para iterar na especificação, as sugestões do Gemini Code Assist não incluem o contexto empresarial do hub de APIs.

Editar uma especificação de API no hub de APIs

Para editar uma especificação de API armazenada no catálogo do hub de APIs, siga as instruções nesta seção. Para fazer a integração com o hub de APIs, o projeto da Apigee precisa ser provisionado com o hub de APIs. Consulte Antes de começar.

1. Verifique se o projeto selecionado no Cloud Code é aquele com o catálogo do hub de APIs contendo a API que você quer editar.
2. Na navegação à esquerda, expanda a árvore do Hub de APIs na seção Apigee.
3. Selecione na lista a API e a versão que você quer editar. Você verá o arquivo YAML e a visualização do painel Swagger da API.

Editar uma especificação de API armazenada localmente

Para editar uma especificação de API armazenada localmente, abra o arquivo no Cloud Code.

Se você criou um pacote de proxy da Apigee na especificação, é possível abrir o arquivo do pacote de proxy no Cloud Code clicando no nome do proxy de API em apiproxies no seu espaço de trabalho da Apigee.

Salvar APIs como pacotes de proxy de API

É possível salvar a API como um pacote de proxy de API da Apigee para trabalhar nela no ambiente de desenvolvimento local da Apigee. Para informações sobre como trabalhar com proxies de API no Cloud Code, consulte Desenvolver proxies de API.

1. Clique em Criar pacote de proxy de API no painel Swagger.
2. No campo de comando, nomeie o proxy de API e continue.
3. O proxy de API aparece no menu à esquerda da Apigee no espaço de trabalho local, em apiproxies.

Publicar APIs no hub de APIs

Se você estiver usando o hub de APIs, poderá disponibilizar suas APIs para outros desenvolvedores registrando-as no hub de APIs:

1. No painel Swagger de uma especificação de API nova ou editada, clique em Publicar no hub de APIs.
2. No formulário, forneça metadados para a API para melhorar a capacidade de descoberta e a organização das APIs no catálogo do hub de APIs. A maioria dos campos é preenchida automaticamente na especificação da API, mas é possível mudar os valores. Consulte Registrar uma API para informações sobre o registro no hub de APIs e os dados que você precisa fornecer.
   • Nome de exibição da API (obrigatório): um nome da API visível para outros desenvolvedores.
   • Descrição da API (opcional): uma descrição da API para referência interna/de desenvolvedor referência.
   • Nome do proprietário da API (opcional): o nome do proprietário da API.
   • E-mail do proprietário da API (opcional): o endereço de e-mail do proprietário.
   • Versão da API (obrigatório): a versão da API.
   • Estágio do ciclo de vida (opcional): selecione um estágio na lista.
3. Clique em Publicar para publicar a API no hub de APIs.
4. Após um breve atraso, as mudanças vão aparecer na árvore do Hub de APIs na seção Apigee do Cloud Code.

Testar APIs usando um servidor simulado

É possível testar a API usando um servidor simulado local ou um servidor simulado remoto baseado em Google Cloud. O servidor simulado local está instalado e disponível por padrão, mas você precisa configurar e gerenciar Google Cloud servidores simulados.

Usar o servidor simulado local

O servidor simulado local aceita solicitações para essa API e emula respostas. Ele só pode ser usado durante a sessão atual pelo usuário atual. No entanto, ao contrário do servidor de simulação remoto, não requer configuração nem gerenciamento e não gera custos.

Além disso, os servidores simulados locais:

• Não funcionam ao usar o Cloud Shell Editor ou o Cloud Workstations.
• Podem não funcionar corretamente ao usar o VS Code Remote Explorer.

Para usar o servidor simulado local:

1. Selecione o servidor simulado local no menu suspenso Servidores (se ainda não estiver selecionado):
   
2. Abra um caminho no painel Swagger e clique em Testar.
   
3. Preencha todos os parâmetros da solicitação e clique em Executar.
   

Usar um servidor simulado remoto

Um servidor simulado remoto permite criar instância de servidor fictício persistente que, ao contrário do servidor simulado local, pode ser compartilhados e usados por outras pessoas na organização para testar a nova API. Os servidores simulados remotos só podem ser usados com APIs registradas no Hub de APIs.

Os servidores simulados remotos não são atualizados automaticamente para nenhuma mudança feita na API depois de implantar o servidor simulado. Portanto, espere para adicionar o servidor simulado tenham criado a API.

A implantação de um Google Cloud servidor simulado remoto cria um novo serviço do Cloud Run. Ele cria a imagem do contêiner para o servidor simulado usando o Cloud Build e o upload da imagem para o Cloud o Artifact Registry no projeto do Google. Consulte O que é o Cloud Run? Como gerenciar serviços e os Documentação do Artifact Registry.

É possível usar a conta de serviço padrão ou fornecer uma conta de serviço mais restrita para implantar o aplicativo do Cloud Run. Consulte Gerenciar APIs do Cloud e bibliotecas de cliente do Cloud no Cloud Code para VS Code para mais informações.

Importante: você é responsável por todos os custos e manutenção resultantes do servidor simulado remoto após a criação. Você também é responsável por excluí-lo quando ele não for mais necessário ou em uso. Consulte Preços do Cloud Run para informações sobre preços, incluindo informações sobre as opções de nível sem custo financeiro.

Para implantar um servidor simulado remoto:

1. Selecione Implantar servidor simulado no painel Swagger.
2. Registre a API quando solicitado, caso ela ainda não esteja registrada no hub da API.
3. Especifique os detalhes do servidor simulado remoto: Nome do servidor, Servidor seguro, Conta de serviço (deixe em branco para usar a conta de serviço padrão) e se quer adicionar o URL do servidor à especificação da API. Clique em Criar para criar o servidor simulado remoto.
   Importante: não crie vários servidores de simulação remota com o mesmo nome, mesmo que a interface do usuário não vão impedir que você faça isso agora.
4. A geração remota do servidor simulado requer vários minutos. Você pode acompanhar o progresso no painel OUTPUT do Cloud Code e na janela pop-up de notificação no canto inferior direito do VS Code.
5. Depois que o processo de criação do servidor simulado remoto estiver concluído, o URL do servidor remoto será exibido na Lista de servidores do painel Swagger e o OUTPUT painel.
6. Para usar o servidor simulado, abra um caminho e clique em Testar.
   
   
   Preencha todos os parâmetros da solicitação e clique em Executar.
   
   
   Também é possível enviar solicitações usando um comando curl. Use o endereço e a porta dos Servidores no menu suspenso.

Para compartilhar o acesso ao servidor simulado com outros usuários:

1. Conceda a outros usuários o papel de chamador para o serviço implantado. Consulte Autenticar desenvolvedores.
2. Ao fazer a solicitação ao servidor simulado, os usuários seguem as instruções em Teste seu serviço particular.

Para gerenciar servidores simulados remotos implantados:

1. Acesse o hub de APIs da Apigee.
2. Encontre a API para ver todas as implantações da API, incluindo as servidores simulados remotos.
3. Use o URL do recurso para acessar a implantação e gerenciá-la, interrompendo, excluindo e realizando outras ações no servidor simulado.