Esta página se aplica à Apigee e à Apigee híbrida.
A página API fornece informações detalhadas sobre uma API. Quando você seleciona uma API na lista APIs, a guia Visão geral da página da API é mostrada.
A guia Visão geral tem as seguintes seções:
Geral
O painel geral exibe informações de nível superior sobre uma API, incluindo as seguintes:
- Nome de exibição: nome de exibição da API. Definido ao registrar a API. Para editar o nome de exibição, consulte Editar detalhes do registro da API.
- Descrição: descrição da API Definido ao registrar a API. Para editar a descrição, consulte Editar detalhes do registro da API.
- Elementos de taxonomia personalizados e do sistema
- Versão do documento: um link que abre a revisão da especificação atualmente atribuída à implantação. Este botão só aparecerá se a API tiver um conjunto de implantações recomendado e se essa implantação tiver uma versão atribuída.
- Receber acesso: fornece instruções sobre como acessar essa API. Para modificar essas instruções, consulte Editar implantação. Esse botão só é exibido quando há um conjunto de implantações recomendado.
Se rótulos ou tags desconhecidos estiverem anexados por meio da API pública, eles não serão exibidos na interface. Somente rótulos que definem as taxonomias conhecidas são exibidos.
Os valores de taxonomia podem ser atribuídos a uma descrição ou um URL de texto. Nesse painel, se um valor de taxonomia for atribuído a uma descrição de texto, um ícone de informações será exibido ao lado do valor que, quando o cursor é exibido, exibe a descrição. Se o valor for um URL, o valor de taxonomia exibido se tornará um hiperlink que abre o URL em uma nova guia do navegador. Consulte Adicionar taxonomia para mais informações.
Editar uma API
Consulte Editar detalhes do registro da API.
Excluir uma API
Consulte Excluir API.
Visão geral
As visões gerais ajudam as equipes a entender como a qualidade de uma API é medida. Em um portfólio de APIs, uma técnica cuidadosa da pontuação pode ajudar a promover a consistência em diferentes áreas, como padrões de design, perfis de segurança, confiabilidade ou outras dimensões importantes para a empresa. O hub de APIs vem com a inspeção da OpenAPI já configurada
A visão geral representa um grupo de classificações que não são facilmente reduzidas a uma única quantidade.
A classificação é um valor único que representa algum aspecto da qualidade de uma API. A qualidade pode ser definida em qualquer contexto (design, confiabilidade, conformidade etc.) e costuma ser uma questão de opinião.
Ocultar a visão geral
Para ocultar a IU da visão geral de cada API, consulte Desativar ou ativar a visão geral da API.
Selecionar a versão da visão geral
Selecione a versão a ser usada na visão geral na lista suspensa Classificar esta especificação:
Em que:
- Última atualização: esta revisão de especificações tem o carimbo de data/hora do upload mais recente.
- Recomendado: esta especificação tem uma das revisões atribuídas à implantação recomendada. Use essa especificação se você for um consumidor da API.
Personalizar a visão geral
Para personalizar e configurar a visão geral, use a ferramenta de linha de comando do registro.
Veja também: Como as pontuações são calculadas?
Se você quiser exibir um ícone de status ao lado dos erros e dos avisos na visão geral, defina limites:
Em que:
| Tipo | Ícone | Descrição |
|---|---|---|
| Alerta |  |
Exibir esse ícone quando o limite estiver dentro do intervalo definido para alertas. |
| Alerta |  |
Exibir esse ícone quando o limite estiver dentro do intervalo definido para avisos. |
| OK |  |
Exibir este ícone quando o limite estiver dentro do intervalo definido para OK. |
Resumo do lint
A configuração padrão da visão geral do hub de API informa avisos e erros de lint para especificações da OpenAPI v2 e da OpenAPI v3 que foram enviados ao hub de APIs. O hub de APIs e o registro incluem um linter padrão baseado em Espectral. Esse linter é fornecido como um exemplo de referência de recursos de lint (sem expectativa de suporte para o próprio Espectral), usando o conjunto de regras de regras da OpenAPI com algumas exceções ativadas para reduzir o ruído de erros comuns. No momento, não é possível estender com linters personalizados.
Consulte Guias de estilo de API no registro para ver instruções sobre como atualizar a configuração do linter.
Implantações
A guia Implantações exibe todas as implantações da API configuradas pelo Editor de API. As implantações representam ambientes ativos em que a API é implantada. As implantações são ordenadas (decrescente) pelo nome do ambiente. Serão exibidas as seguintes informações:
- Ambiente
- Documentação
- Indicador de implantação recomendado:
- Gateway
- Orientação de uso
- Canal externo
- Conseguir acesso
Para mais informações, consulte Gerenciar implantações.
Versões
A guia Versões exibe todas as versões que foram definidas para a API. As versões são ordenadas (decrescente) por número da versão. Serão exibidas as seguintes informações:
- Versão
- Etapa do ciclo de vida
- Última revisão
- Fim da vida útil
Para mais informações, consulte Gerenciar versões.
Temas relacionados
O painel Relacionados, exibido na parte inferior da página Visão geral da API, fornece links para diversas informações relacionadas à API. Por exemplo, código-fonte da implementação, documentação do projeto e sistemas de infraestrutura. Para mais informações, consulte Relacionados.
Dependências
O painel Dependências, exibido na parte inferior da página Visão geral da API, lista todas as dependências da API, incluindo outras APIs internas (presentes no hub de APIs), APIs de terceiros externas (não presentes no hub de APIs) e outros sistemas de produção. Por exemplo, bancos de dados e soluções de armazenamento. Para mais informações, consulte Dependências.
