Attributes

A tela Attributes é encontrada dentro de Governance, no menu principal do Manager. Ela oferece uma funcionalidade de classificação de APIs por meio de tags personalizáveis, o que aumenta a rastreabilidade dentro do portfólio das APIs e o entendimento do contexto de negócio em que as APIs estão inseridas. Além disso, como é possível criar atributos com base em regras de negócio, a funcionalidade dá uma maior visibilidade da estratégia de APIs seguida.

attributes

Os atributos são formados por um nome acompanhado de um ou mais valores (as tags, ou etiquetas). Depois de cadastrar os atributos que condizem com as suas necessidades de governança, você pode associar esses atributos e tags às suas APIs, promovendo uma classificação para elas. E você também pode utilizar os atributos como requisitos dos workflows.

Isso significa que, quando você cria atributos adequados aos modelos de negócio da sua empresa, você consegue associar determinadas APIs a um modelo de negócio específico e, com os workflows, garantir que as APIs usem os atributos adequados. Em exemplos abaixo, como ilustração disso, classificamos APIs por unidade de negócio (business unit), incluindo as áreas de Marketing, P&D (R&D) e Vendas (Sales).

A tela Attributes inclui uma área para inclusão de novos atributos e a lista de atributos já criados. A associação de atributos a APIs é feita na criação ou edição de uma API (APIs  Overview).

Gerenciando atributos

Cadastro

Para cadastrar um novo atributo, informe um nome no campo Name e insira as tags que desejar no campo Value (é possível adicionar até 30 tags por atributo). Quando terminar de adicionar as tags, clique em ADD ATTRIBUTE.

Regras que se aplicam à criação de atributos:

  • atributos devem ter um nome único;

  • máximo de 30 valores por atributo;

  • não é possível usar o caractere : no nome ou valor do atributo;

  • nomes e valores devem ter no mínimo 3 caracteres e no máximo 40.

No exemplo abaixo, vemos uma tela de atributos vazia e vamos adicionar um primeiro atributo, formado pelo nome Business Unit e valores referentes às diferentes áreas de negócio:

attributes new

Edição

Você pode editar um atributo já criado, modificando seu nome e/ou valores.

Para isso, clique no ícone icon edit, na linha do atributo desejado, dentro da lista de atributos existentes. Para remover uma tag, clique no ícone X ao lado do seu nome.

O sistema não permitirá que você exclua uma tag se ela estiver associada a uma API. Veja como vincular tags a APIs abaixo.

No exemplo abaixo, estamos editando o atributo Business Unit criado acima, adicionando uma nova área e substituindo uma das áreas por outro valor:

attributes edit

Exclusão

Você pode excluir completamente um atributo (apagando o nome e todos os valores). Para isso, clique no ícone icon delete na linha do atributo desejado, dentro da lista de atributos existentes.

O sistema não permitirá que você apague um atributo se ele estiver vinculado a uma API (veja como vincular atributos a APIs abaixo).

Por outro lado, é possível apagar um atributo que esteja associado somente a um workflow. Por isso, sugerimos que você verifique se um atributo está associado a um workflow antes de removê-lo, analisando se ele realmente deve ser deletado. Veja como usar os atributos como requisitos de workflows aqui.

Depois de um atributo ter sido cadastrado, ele pode ser associado às APIs que queremos categorizar por meio de suas tags.

Como exemplo, imagine que temos duas APIs, a API "A" e a API "B", e queremos vincular o atributo Business Unit a elas: a tag Marketing será associada à API "A" e a tag R&D será associada à API "B". Nesse caso, ambas as APIs estarão classificadas com o mesmo atributo Business Unit, mas com tags (valores) diferentes.

Para vincular o atributo às APIs, selecionaremos a composição Nome:valor. Ou seja, a API "A" terá o atributo Business Unit:Marketing e a API "B" terá o atributo Business Unit:R&D.

A vinculação de atributos a uma API é feita na tela de cadastro ou edição da API (mais especificamente, no campo Attributes da seção API Basic Definitions). Você pode ler mais sobre a criação/edição de APIs aqui.

No exemplo abaixo, estamos trabalhando com uma API de demonstração para uso na documentação técnica do Adaptive Governance. Para categorizá-la de forma condizente, vamos adicionar o atributo Documentation:Adaptive Governance:

attributes api link

Depois de vincular atributos e APIs, podemos nos beneficiar da funcionalidade de busca avançada de APIs, usando atributos ou tags para filtragem. Você pode ler mais sobre a busca avançada de APIs aqui.

Thanks for your feedback!
EDIT
How useful was this article to you?