Esta página se aplica à Apigee e à Apigee híbrida.
Sobre as especificações da API
As especificações da API usam formatos padrão para descrever APIs. São legíveis por máquinas, mas também fáceis de ler e entender. Normalmente, as especificações descrevem elementos de uma API, como o caminho de base, caminhos e verbos, cabeçalhos, parâmetros de consulta, operações, tipos de conteúdo, descrições de resposta e assim por diante, conforme mostrado na Figura 1.
Figura 1. Trecho de uma especificação da OpenAPI.
Uma versão da API pode conter várias especificações de API do mesmo tipo ou de tipos diferentes, como especificação OpenAPI, Proto e WSDL. Quando compatível, o hub de API pode analisar uma especificação para extrair e armazenar os metadados dela, como ID, ID da versão, descrição e operações. Consulte Análise de especificação.
Como usar especificações da API com o hub da API
É possível criar um recurso de API no hub de API com ou sem uma especificação de API.
Você pode fazer upload de uma especificação ao criar uma versão. Ao visualizar os detalhes de uma API na interface do usuário, você verá uma lista de todas as especificações associadas às versões de um recurso da API.
Também é possível criar e configurar uma versão com uma especificação usando a API REST. Ao usar a API, você cria uma entidade de versão da API com a especificação e, em seguida, anexa a versão a um recurso da API.
Para saber mais, consulte Adicionar uma especificação a uma versão.
Análise de especificação
Quando compatível, o hub de API pode analisar uma especificação para extrair informações e armazená-las com uma versão da API. Por exemplo, o hub de API pode analisar uma especificação OpenAPI da API para extrair e armazenar o ID da API, o ID da versão, a descrição, as operações e outros metadados.
O hub de API também oferece suporte à validação de especificações. Consulte Validar uma especificação de API.