Attributes

La pantalla Attributes se encuentra en Governance, en el menú principal del Manager. Ofrece una herramienta que clasifica las APIs en función de etiquetas personalizables, lo que facilita la rastreabilidad dentro del catálogo de APIs y la comprensión del contexto de negocio en que las APIs están integradas. Además, dado que puede crear atributos siguiendo reglas de negocio, la función garantiza más visibilidad a la estrategia de APIs de la empresa.

attributes

Los atributos se componen de un nombre acompañado de uno o más valores (las tags, o etiquetas). Después de ingresar los atributos que se ajustan a sus necesidades de gobierno, puede asociar estos atributos y etiquetas con sus APIs, clasificándolas. Y puede también utilizar los atributos como requisitos para los workflows.

Esto significa que, cuando crea atributos que se ajustan a los modelos de negocio de su empresa, puede clasificar sus APIs asociándolas con un modelo determinado y, con los workflows, garantizar que las APIs utilicen los atributos adecuados. En ejemplos de esta página, como ilustración de esto, clasificamos las APIs por unidad de negocio (business unit), incluidas las áreas de Marketing, I+D (R&D) y Ventas (Sales).

La pantalla Attributes incluye un área para agregar nuevos atributos y la lista de atributos existentes. La asociación entre las APIs y los atributos tiene lugar cuando registra o edita una API (APIs  Overview).

Administración de atributos

Registro

Para registrar un nuevo atributo, ingrese un nombre para él (en el campo Name e ingrese las etiquetas que desee en el campo Value (se pueden añadir un total de 30 etiquetas por atributo). Cuando haya terminado de añadir los valores, haga clic en ADD ATTRIBUTE.

Reglas que se aplican a la creación de atributos:

  • los atributos deben tener un nombre único;

  • máximo de 30 valores por atributo;

  • no se puede utilizar el carácter : en el nombre o valor del atributo;

  • los nombres y los valores deben ser de al menos 3 caracteres y no más de 40.

En el siguiente ejemplo, vemos una pantalla de atributos vacía y añadiremos un primer atributo, formado por el nombre Business Unit y valores referentes a diferentes áreas de negocio:

attributes new

Edición

Puede editar un atributo existente, modificando su nombre y/o valores.

Para hacerlo, haga clic en el icono icon edit en la fila del atributo deseado (en la lista de atributos existentes). Para eliminar una etiqueta, haga clic en el icono X junto a su nombre.

El sistema no permitirá eliminar una etiqueta si actualmente está asociada con una API. Vea cómo vincular etiquetas y APIs a continuación.

En el siguiente ejemplo, editamos el atributo Business Unit que creamos en el ejemplo anterior, añadiendo dos nuevos valores y borrando uno antiguo:

attributes edit

Eliminación

Puede eliminar un atributo por completo. Para hacerlo, haga clic en el icono icon delete en la fila del atributo deseado (en la lista de atributos existentes).

El sistema no permitirá eliminar un atributo si actualmente está asociado con una API (vea cómo vincular atributos y APIs a continuación).

Por otro lado, es posible eliminar un atributo que sólo está asociado a un workflow. Por lo tanto, le sugerimos que compruebe si un atributo está asociado a un flujo de trabajo antes de eliminarlo, analizando si realmente debe ser eliminado. Vea cómo utilizar atributos como requisitos de workflows aquí.

Una vez que se ha registrado un atributo, se puede asociar con las APIs que queremos categorizar bajo sus etiquetas.

Como ejemplo, imagina que tenemos dos APIs, API «A» y API «B», y queremos vincular el atributo Business Unit a ellas: la etiqueta Marketing se asociará con la API «A», mientras que la etiqueta R&D se asociará con la API «B». En este caso, ambas APIs se clasificarán bajo el atributo Business Unit, pero con etiquetas diferentes.

Para vincular el atributo a las APIs, seleccionaremos la composición Nombre:valor. Es decir, la API «A» tendrá el atributo Business Unit:Marketing y la API «B» tendrá el atributo Business Unit:R&D.

Puede vincular atributos a una API en la pantalla de registro o edición de una API (más específicamente, en el campo Attributes de la sección API Basic Definitions). Puede leer más sobre la creación/edición de APIs aquí.

En el ejemplo que figura a continuación, tenemos una API de demostración para usar en la documentación técnica del Adaptive Governance. Para categorizarla de acuerdo con esto, añadiremos el atributo Documentation:Adaptive Governance:

attributes api link

Después de vincular atributos y APIs, podemos beneficiarnos de la función de búsqueda avanzada de APIs, utilizando atributos o etiquetas para filtrarlas. Puede leer más sobre la búsqueda avanzada de APIs aquí.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]