Tutorial: registrar APIs no inventário de API
Neste tutorial, inicie o inventário de API no centro de API da sua organização, registrando APIs e atribuindo metadados com o portal do Azure.
Para obter informações básicas sobre APIs, versões de API, definições e outras entidades que você poderá inventariar no Centro de API do Azure, consulte Conceitos principais.
Neste tutorial, você aprenderá a usar o portal para:
- Registrar uma ou mais APIs
- Adicionar uma versão de API a uma definição de API
Pré-requisitos
Um centro de API na sua assinatura do Azure. Se você ainda não criou um, consulte Início Rápido: criar seu centro de API.
Uma ou mais APIs que você deseja registrar no seu Centro de API. Aqui estão dois exemplos, com links para suas definições do OpenAPI:
Conclua o tutorial anterior, Definir metadados personalizados, para definir metadados personalizados para suas APIs.
Registrar APIs
Ao registrar (adicionar) uma API no centro de API, o registro de API inclui:
- Um título (nome), tipo e descrição
- Informações da versão
- Links opcionais para documentação e contatos
- Metadados internos e personalizados que você definiu
Após registrar uma API, adicione versões e definições à API.
As etapas a seguir registram dois exemplos de APIs: API da Loja de Animais de Estimação Swagger e API da Conferência (consulte Pré-requisitos). Se preferir, registre suas próprias APIs.
No portal, navegue até seu centro de API.
No menu à esquerda, em Ativos, selecione APIs>+ Registrar uma API.
Na página Registrar uma API, adicione as seguintes informações para a API da Loja de Animais de Estimação Swagger. Você visualizará os metadados personalizados de Linha de negócios e Voltado para o público definido no tutorial anterior na parte inferior da página.
Configuração Valor Descrição Título da API Insira a API da Loja de Animais de Estimação Swagger. O nome que você escolher para a API. Identificação Após você inserir o título anterior, o Centro de API do Azure gera esse identificador, que pode ser substituído. Nome do recurso do Azure para a API. Tipo de API Selecione REST na lista suspensa. Tipo de API. Resumo Opcionalmente, insira um resumo. Descrição resumida da API. Descrição Insira uma descrição opcionalmente. A descrição da API. Versão Título da versão Insira um título para a versão de sua escolha, como v1. O nome que você escolheu para a versão da API. Identificação da versão Após você inserir o título anterior, o Centro de API do Azure gera esse identificador, que pode ser substituído. O nome do recurso do Azure para a versão. Ciclo de vida da versão Faça uma seleção na lista suspensa, por exemplo, Testando ou Produção. Estágio do ciclo de vida da versão da API. Documentação externa Opcionalmente, adicione um ou mais links para documentação externa. Nome, descrição e URL da documentação da API. Licença Opcionalmente, adicione informações de licença. Nome, URL e ID de uma licença para a API. Informações do contato Opcionalmente, adicione informações para um ou mais contatos. Nome, email e URL de um contato para a API. Linha de negócios Caso adicionou estes metadados no tutorial anterior, faça uma seleção na lista suspensa, como Marketing. Os metadados personalizados que identificam a unidade de negócios proprietária da API. Voltado para o público Caso adicionou esses metadados, marque a caixa de seleção. Os metadados personalizados que identificam se a API é voltada para o público ou apenas interna. 
Selecione Criar. A API está registrada.
Repita as três etapas anteriores para registrar outra API, como a API da Conferência.
Dica
Ao registrar uma API no portal, você pode selecionar qualquer um dos tipos de API predefinidos ou inserir outro tipo de sua escolha.
As APIs aparecem na página APIs do portal. Quando você tiver adicionado um grande número de APIs ao Centro de API, use a caixa de pesquisa e os filtros dessa página para encontrar as APIs desejadas.
Após registrar uma API, você pode exibir ou editar as propriedades da API. Na página APIs, selecione a API para visualizar as páginas de gerenciamento do registro da API.
Adicionar uma versão da API
Ao longo do seu ciclo de vida, uma API pode ter várias versões. Você pode adicionar uma versão a uma API existente no seu Centro de API, opcionalmente com um arquivo ou arquivos de definição atualizado.
Aqui você adiciona uma versão a uma das suas APIs:
No portal, navegue até seu Centro de API.
No menu à esquerda, selecione APIs e, em seguida, selecione uma API, por exemplo, Swagger Petstore.
Na página de API, em Detalhes, selecione Versões>+ Adicionar versão.
Na página Adicionar versão da API:
Insira ou selecione as seguintes informações:
Configuração Valor Descrição Título da versão Insira um título para a versão de sua escolha, como v2. O nome que você escolheu para a versão da API. Identificação da versão Após você inserir o título anterior, o Centro de API do Azure gera esse identificador, que pode ser substituído. O nome do recurso do Azure para a versão. Ciclo de vida da versão Faça uma seleção na lista suspensa, como Produção. Estágio do ciclo de vida da versão da API. Selecione Criar. A versão é adicionada.
Adicionar uma definição à sua versão
Normalmente, você desejará adicionar uma definição de API à sua versão de API. O Centro de API do Azure dá suporte a definições em formatos comuns de especificação de texto, como OpenAPI 2 e 3 para APIs REST.
Para adicionar uma definição de API à sua versão:
Na página Versões da API, selecione a versão da API.
No menu à esquerda da versão da API, em Detalhes, selecione Definições>+ Adicionar definição.
Na página Adicionar definição:
Insira ou selecione as seguintes informações:
Configuração Valor Descrição Título Insira um título de sua escolha, como Definição v2. O nome que você escolheu para a definição da API. Identificação Após você inserir o título anterior, o Centro de API do Azure gera esse identificador, que pode ser substituído. Nome do recurso do Azure para a definição. Descrição Insira uma descrição opcionalmente. Descrição da definição da API. Nome da especificação Para a API Petstore, selecione OpenAPI. Formato de especificação para a API. Versão da especificação Insira um identificador de versão de sua escolha, como 3.0. Versão de especificação. Documento Navegue até um arquivo de definição local para a API Petstore ou insira um URL. Exemplo de URL: https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yamlArquivo de definição de API. 
Selecione Criar. A definição é adicionada.
Neste tutorial, você aprendeu a usar o portal para:
- Registrar uma ou mais APIs
- Adicionar uma versão de API a uma definição de API
À medida que você cria seu inventário de API, aproveite as ferramentas automatizadas para registrar APIs, como a extensão do Centro de API do Azure para Visual Studio Code e a CLI do Azure.
Próximas etapas
Seu inventário de API está começando a tomar forma! Agora você pode adicionar informações sobre os ambientes e implantações de API.