Tutorial: Definir metadados personalizados
Neste tutorial, defina metadados personalizados para ajudá-lo a organizar suas APIs e outras informações em seu centro de APIs. Use metadados personalizados e internos para pesquisa e filtragem e para impor padrões de governança em sua organização.
Para obter informações básicas sobre metadados na Central de APIs do Azure, consulte:
Neste tutorial, você aprenderá a usar o portal para:
- Definir metadados personalizados no seu centro de API
- Exibir o esquema de metadados
Pré-requisitos
- Um centro de API na sua subscrição do Azure. Se você ainda não criou um, consulte Guia de início rápido: criar sua central de API.
Definir metadata
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 internos personalizados e comuns.
Importante
Não inclua informações confidenciais, confidenciais ou pessoais nos títulos (nomes) dos metadados que definir. Esses títulos são visíveis nos logs de monitoramento usados pela Microsoft para melhorar a funcionalidade do serviço. No entanto, outros detalhes e valores de metadados são os dados protegidos do cliente.
No portal do Azure, navegue até o centro de APIs.
No menu à esquerda, em Ativos, selecione Metadados> + Novos metadados.
Na guia Detalhes, insira informações sobre os metadados.
Em Título, insira Linha de negócios.
Opcionalmente, insira uma Descrição.
Selecione o tipo Opções predefinidas e insira opções como Marketing, Finanças, TI, Vendas e assim por diante. Opcionalmente, ative Permitir seleção de vários valores. Selecione Seguinte.
Na guia Atribuições, selecione Necessário para APIs. Selecione Opcional para implantações e ambientes. (Você adicionará essas entidades em tutoriais posteriores.) Selecione Avançar.
No separador Rever + criar, reveja as definições e selecione Criar.
Os metadados são adicionados à lista na página Metadados .
Selecione + Novos metadados para adicionar outro exemplo.
Na guia Detalhes, insira informações sobre os metadados.
Em Título, insira Voltado para o público.
Selecione o tipo Booleano.
Na guia Atribuições, selecione Necessário para APIs. Selecione Não aplicável para implantações e ambientes.
No separador Rever + criar, reveja as definições e selecione Criar.
Os metadados são adicionados à lista.
Exibir esquema de metadados
Você pode exibir e baixar o esquema JSON para os metadados definidos em seu centro de API. O esquema inclui metadados internos e personalizados.
No menu à esquerda, em Ativos, selecione Esquema de metadados de exibição de metadados>.
Selecione Exibir APIs de 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 em seu centro de API.
Próximos passos
Neste tutorial, você aprendeu como usar o portal para:
- Definir metadados personalizados no seu centro de API
- Exibir o esquema de metadados
Agora que você preparou seu esquema de metadados, adicione APIs ao inventário em seu centro de APIs.