Header Ads Widget

Ticker

6/recent/ticker-posts

Cómo construir y hacer cumplir una excelente gobernanza de API

En el amplio mundo de las API web, la necesidad de gobernanza y estándares compartidos aumenta a medida que una empresa considera seriamente el valor de sus datos y la estrategia de la plataforma. Sin embargo, armar el enfoque de gobernanza adecuado es un acto de equilibrio de prioridades.
Los arquitectos de plataformas deben equilibrar una directiva de arriba hacia abajo y las necesidades de un desarrollador de abajo hacia arriba. Deben considerar cómo actualizar las estructuras de datos heredadas. Deben implementar estándares de API a prueba de futuro que duren. Deben imponer estilo . Además de eso, el gobierno de API debe considerar cómo cumplir con las regulaciones gubernamentales y los estándares del sector industrial, como GDPR para la privacidad de los datos, PSD2 para la banca abierta o FIHR en la atención médica .
Afortunadamente, han surgido mejores prácticas. Con OpenAPI Specification y el ecosistema de herramientas circundante, los proveedores de API están bien posicionados para construir un enfoque de gobierno que funcione. En nuestro LiveCast, Gobernanza de API centrada en el consumidor , incorporamos a los expertos Alianna Inzana, Smartbear y Kin Lane, Postman, para analizar cómo crear y hacer cumplir políticas de API justas en toda la plataforma que aceleren los objetivos comerciales.
Vea LiveCast de gobernanza de API centrada en el consumidor:

La gobernanza de API comienza con el elemento humano

Alianna Inzana
Alianna Inzana , directora senior de gestión de productos en SmartBear , aporta el elemento humano para simplificar la gobernanza de API.
Cuando comienza a considerar el valor creciente de los datos , cómo se exponen se convierte en una preocupación legítima. Lagos de datos desagradables, los sistemas interoperables y las incoherencias de código malolientes pueden afectar negativamente la experiencia del desarrollador . Las API, como capas de abstracción, pueden heredar fácilmente estos defectos.
Según Alianna Inzana, la gobernanza es "una parte esencial de la estrategia de una empresa API". La gobernanza de API es fundamental tanto para los creadores de API como para los consumidores, ya que brinda a las personas interesadas en los productos un mejor apalancamiento y genera confianza en su marca.
Pero dictar una única forma de pensar puede resultar complicado. La frase "gobernanza" tiende a evocar una imagen rígida y conformista. La idea de un mandato estricto desde lo alto se siente opresiva y limita la creatividad. En resumen, la gobernanza no siempre es adoptada con alegría por una comunidad de desarrolladores .
Es por eso que Inzana señala que "la participación humana es el comienzo de cualquier viaje de gobernanza de API". Según Inzana, primero viene la gente , luego viene el proceso , luego las herramientas . Este proceso debe equilibrar la entrada de dos partes interesadas: los requisitos de arriba hacia abajo y la entrada del usuario del desarrollador de abajo hacia arriba.

5 elementos para un gobierno sencillo

Alianna Inzana recurre a las 10 leyes de la simplicidad de John Maeda como una parábola para el gobierno de API simple.
Su estrategia de gobierno de API imitará sus prácticas de diseño de API. Entonces, ¿qué hace un buen diseño? Tome las leyes de la simplicidad . Estos principios de diseño de John Maeda se relacionan con muchas facetas de la tecnología y los negocios. Inzana describe cómo aplicar al menos cinco de ellos para simplificar una estrategia de gobierno de API:
  1. Reducir : Primero, haga un inventario de los recursos y el valor de su organización. “Los viajes de gobernanza a menudo comienzan con hacer un balance”, dice Inzana. Esto podría significar una considerable reducción de residuos.
  2. Organizar : La organización hace que un sistema de muchos parezca menos. "Hay una ventaja evolutiva en encontrar patrones y utilizarlos", señala Inzana. Encontrar denominadores comunes es un buen comienzo, pero para impulsar la coherencia, la gobernanza de API requiere organización.
  3. Tiempo : como capas orientadas a solicitudes y respuestas, las API mantienen una relación especial con el tiempo. El gobierno puede expandirse para ofrecer acuerdos de nivel de servicio (SLA) que consideran el tiempo de actividad .
  4. Aprender : aprenda e implemente una guía de estilo de API Los contratos de API proporcionan una estructura estándar que es legible por máquina, pero las organizaciones también requieren un libro de reglas legible por humanos.
  5. Confianza : "La gobernanza de API puede generar confianza dentro de una organización", señala Inzana. Desarrollar un hábito de coherencia demuestra lo que es esencial para su organización, aliviando los bloqueos de DX y las preocupaciones de seguridad.
¿Sus prácticas de API son coherentes por intención o por accidente? Dado que el objetivo de la gobernanza de API es crear un contrato entre el proveedor y el consumidor, la gobernanza de API realmente se reduce a la confianza . Incluso las inconsistencias menores, como algunas funciones que no usan CamelCase, o métodos que usan diferentes estilos de manejo de errores , crean lo que Inzana llama "olor a código". La inconsistencia del código genera una reacción psicológica que podría afectar negativamente la experiencia del desarrollador e infundir desconfianza en la plataforma.
Es bueno privilegiar la sustancia sobre el estilo, pero la facilidad de uso triunfa sobre todo. Para lograr una mejor usabilidad, Inzana recomienda calibrar la gobernanza a las necesidades de las personas . "Si el objetivo es la simplicidad ... el proceso tiene que girar en torno a la unificación de las personas". Este proceso debe ser colaborativo.

Implementación de la gobernanza de API con pruebas de contrato

Kin Lane
Kin Lane , evangelista jefe de Postman , considera que las pruebas de contrato son el mejor camino hacia la gobernanza de API en primer lugar en el diseño.
Un contrato, en forma de especificación de API , puede ser el mejor amigo de una API. Una única fuente de verdad. Una poderosa herramienta para unir a todas las partes interesadas. Y quizás, el mejor aliado de los gobernadores de API.
Kin Lane describe la explosión cámbrica de API en el mercado. Desde que comenzó a cubrir la economía de las API en 2010, ha visto cómo nuestro espacio aumentaba de cientos de API públicas a más de 20.000. También hemos visto la estandarización en torno a los formatos de especificación de API. De los  debates RAML vs. API Blueprint vs. Swagger surgió una aceptación general de la industria en torno a la Especificación OpenAPI.
Aunque la economía de las API está madurando, Lane señala que aún, con algunas excepciones, la mayoría de las API están mal construidas. “Existe una desconexión entre los productores de API y los consumidores”, dice Lane. Una inversión en gobernanza a través de una mentalidad de especificación primero podría ayudar a "traer armonía entre estas dos caras de la moneda".
Dado que OpenAPI ha surgido como un formato de especificación estandarizado para describir API, tiene sentido preparar una estrategia de gobernanza que cuente con OpenAPI. Como Lane describe acertadamente, "el diseño de API es un fármaco de entrada para la gobernanza de API ... OpenAPI y ser el diseño primero abre la puerta y sienta las bases para la gobernanza de API".
En términos de implementar realmente un proceso de gobierno repetible, Lane recomienda la colaboración mediante Postman. Como describe Lane, Postman no solo puede validar las API, sino también verificar los contratos de especificación ellos mismos. Las pruebas de contrato de esta manera se simplifican con Postman Collections.
Con las herramientas adecuadas, los proveedores de API podrían desarrollar rápidamente un proceso de prueba que proporcione avisos de PASA o FALLA para preguntas simples como:
  • ¿Es JSON válido?
  • ¿Es un esquema JSON válido?
  • ¿Es 200 el estado?
  • ¿Tienes cuerpo?
Estas pruebas podrían desarrollarse en todos los ámbitos para garantizar el cumplimiento de las preocupaciones sobre nombres, diseño, seguridad e incluso normativas. En cuanto a la regulación, Lane señala cómo está construyendo colecciones específicas abiertas para su reutilización pública. Estas plantillas se adaptan a puntos de referencia regulatorios como FIHR.
El uso de una herramienta de SmartBear o Postman para las pruebas de API significa que puede usar la misma infraestructura para probar el contrato de API y la documentación . Con estas habilidades, puede manejar la gobernanza y el cumplimiento de las guías de estilo internas “La gente no siempre ve esto como gobernanza”, dice Kin. "Pero estos son los primeros pasos hacia la gobernanza y hacia la prestación de un servicio confiable".

Reflexiones finales: la matriz de priorización de la gobernanza de API

Al construir la gobernanza de API, existen muchas prioridades en competencia. La administración necesita mano de hierro, pero debe apaciguar a todas las partes interesadas. Es posible que deba trabajar con formatos de datos antiguos y, sin embargo, abstraerlos para facilitar su uso. La API requiere un contrato firme, pero sus prácticas deben ser lo suficientemente flexibles para abarcar nuevos casos de uso.
Sobre ese último punto, Inzana señala cómo la gobernanza debe coevolucionar con la industria. Por ejemplo, los protocolos asincrónicos como AsyncAPI "amplían la definición de gobernanza de API" para abarcar otros servicios.
Si bien el aspecto humano es esencial para que la gobernanza siga siendo vital, una gran parte de garantizar el valor comercial son las herramientas. OpenAPI, ahora un estándar abierto de la industria, ayuda a garantizar que alcancemos este valor comercial. En términos de implementación real, como describe Lane, usar OpenAPI tanto para generar documentación como para actuar como un contrato es una estrategia de referencia para la gobernanza del diseño primero.
Si está perdido en una matriz de gobierno de prioridades en competencia, considere los pensamientos duraderos de Inzana: “Alinee el gobierno con la estrategia y los objetivos comerciales. La estrategia corporativa es parte de cómo se define lo que es importante ".

Publicar un comentario

0 Comentarios