Tutorial: definir metadados personalizados
Neste tutorial, defina metadados personalizados para ajudar você a organizar suas APIs e outras informações em seu centro de API. Use os metadados personalizados e internos para pesquisa e filtragem e para impor padrões de governança em sua organização.
Para obter informações em segundo plano sobre metadados no Centro de API do Azure, consulte:
Neste tutorial, você aprenderá a usar o portal para:
- Definir metadados personalizados no centro de API
- Exibir o esquema de metadados
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.
Definir metadados
Aqui você define dois exemplos de metadados personalizados: linha de negócios e voltado para o público; se preferir, defina outros metadados próprios. Ao adicionar ou atualizar APIs e outras informações em seu inventário, você definirá valores para metadados personalizados e quaisquer metadados internos comuns.
Importante
Não inclua informações confidenciais ou pessoais nos títulos (nomes) dos metadados que você definir. Esses títulos ficam visíveis nos logs de monitoramento utilizados pela Microsoft para melhorar a funcionalidade do serviço. Entretanto, outros detalhes e valores de metadados são seus dados de cliente protegidos.
No portal do Azure, navegue até o centro de API.
No menu à esquerda, em Ativos, selecione Metadados > + Novos metadados.
No guia Details, insira as informações sobre os metadados.
Em Título, insira Linha de negócios.
Se quiser, insira uma Descrição.
Selecione o tipo Escolhas predefinidas e insira opções como Marketing, Finanças, TI, Vendas e assim por diante. Opcionalmente, habilite Permitir seleção de vários valores. Selecione Avançar.
Na guia Atribuições, selecione Obrigatório para APIs. Selecione Opcional para Implantações e Ambientes. (Você adicionará essas entidades em tutoriais posteriores.) Selecione Avançar.
No guia Revisar + criar, revise as configurações e selecione Criar.
Os metadados são adicionados à lista na página Metadados.
Selecione + Novos metadados para adicionar outro exemplo.
No guia Details, insira as informações sobre os metadados.
Em Título, digite Voltado para o público.
Selecione o tipo Booliano.
Na guia Atribuições, selecione Obrigatório para APIs. Selecione Não aplicável para Implantações e Ambientes.
No guia Revisar + criar, revise as configurações e selecione Criar.
Os metadados são adicionados à lista.
Ver esquema de metadados
É possível exibir e baixar o esquema JSON para os metadados definidos no centro de API. O esquema inclui propriedades internos e personalizados.
No menu à esquerda, em Ativos, selecione Metadados Exibir esquema de metadados>.
Selecione Exibir APIs esquema de metadados> para ver o esquema de metadados para APIs, que inclui metadados internos e personalizados. Você também pode exibir o esquema de metadados definido para implantações e ambientes no centro de API.
Próximas etapas
Neste tutorial, você aprendeu a usar o portal para:
- Definir metadados personalizados no centro de API
- Exibir o esquema de metadados
Agora que você preparou seu esquema de metadados, adicione APIs ao estoque no centro de API.