Por qué es importante la experiencia de desarrollo con las API

Rajesh BavananthamDirector de Gestión de Producto | NGINX

Esta es la segunda entrada de una serie de dos partes sobre API Connectivity Manager:

• 5 formas de combatir la proliferación de API (y por qué debería importarte)
• Por qué es importante la experiencia de los desarrolladores de API: este artículo

Las API son fundamentales para las empresas modernas. Aunque siempre han desempeñado un papel importante en el desarrollo de software, la creciente demanda de integración de datos está impulsando una adopción más generalizada de las API en todas las áreas de negocio. Pero las API no se limitan a conectar datos y aplicaciones: son esenciales para colaborar con socios comerciales externos, prestar servicios a los clientes y generar ingresos como productos por derecho propio.

Los desarrolladores desempeñan un papel fundamental en el centro de la economía de las API. Como responsables de crear, integrar y mantener las API, son tanto sus creadores como quienes las adoptan desde el punto de vista técnico. Su experiencia, conocida habitualmente como «experiencia del desarrollador de API», es uno de los factores más importantes para determinar el éxito general de una API. Este artículo analiza los conceptos clave de la experiencia del desarrollador de API y lo que los responsables de TI deben tener en cuenta al planificar la experiencia de las API.

1. ¿Qué es la experiencia de desarrollo de API?
2. ¿Por qué es importante la experiencia de desarrollo de API?
3. ¿Cómo se crean experiencias excelentes para desarrolladores de API?

¿Qué es la experiencia de desarrollo con API?

La experiencia del desarrollador de API describe las percepciones y emociones generales que experimenta un desarrollador al interactuar con una API. Abarca la infraestructura, las herramientas, los procesos, el soporte y otros puntos de contacto que contribuyen a ofrecer una experiencia agradable y fluida a los desarrolladores que integran API en sus aplicaciones. La experiencia del desarrollador de API es una subdisciplina de la experiencia general del desarrollador.

¿Por qué es importante la experiencia de desarrollo con API?

Si centrarse de forma incansable en la experiencia de usuario impulsó la primera generación de innovación tecnológica, la próxima generación de empresas de éxito triunfará centrándose en la experiencia del desarrollador.

A medida que la economía de las API sigue expandiéndose, los desarrolladores tienen cada vez más influencia sobre qué API se adoptan. Cuando una API es difícil de encontrar, carece de documentación adecuada o no se mantiene correctamente, los desarrolladores la descartan en favor de una alternativa más sencilla y rápida. Esto se aplica tanto a los programas de API internos como a las API externas para socios y clientes.

En el caso de las API externas, el abandono de su API por parte de los desarrolladores tiene consecuencias empresariales tangibles. No solo pierde ingresos procedentes de clientes directos, sino también el acceso al ecosistema más amplio de productos y soluciones que utilizan sus clientes. Incluso los programas de API internas sufren las consecuencias de una mala experiencia para los desarrolladores, como un mayor tiempo de comercialización, una menor productividad de los desarrolladores y un aumento del trabajo repetido, lo que puede poner en peligro el éxito de su empresa.

Para triunfar en un mundo centrado en los desarrolladores, necesita una estrategia de API que proporcione las herramientas y los recursos adecuados a los desarrolladores que trabajan en cada etapa del ciclo de vida de las API. La mejor forma de lograrlo es crear para los desarrolladores una experiencia de API integral y bien diseñada que abarque tres tipos de uso de las API:

• Despliegue y gestión de API
• Descubrir y probar APIs
• Monitorización y protección de APIs

¿Cómo se crean experiencias excelentes para desarrolladores de API?

Crear una experiencia positiva implica comprender cómo utilizan los desarrolladores tu API, qué necesitan para completar sus tareas y, en última instancia, cómo se sienten al usarla. Una vez que hayas definido los perfiles de usuario que interactuarán con tus API, podrás empezar a planificar la experiencia global de las API.

Hay cuatro principios que deben tenerse en cuenta al diseñar la experiencia de desarrollo con la API:

1. Identificar a los usuarios – ¿Quién interactúa con la API?
2. Definir la funcionalidad – ¿Qué hace la API?
3. Optimizar la usabilidad – ¿Es fácil de usar la API?
4. Mejorar la experiencia – ¿Qué sensación produce usar la API?

Veamos cada principio y qué debes ofrecer para crear una experiencia de API óptima para los desarrolladores.

Paso 1: Identificar a los usuarios

Al igual que diseñas productos para resolver problemas específicos de los clientes, debes diseñar la experiencia de las API en toda tu infraestructura y tus productos para responder a las necesidades de los desarrolladores. Los desarrolladores son más que los consumidores finales: también son quienes construyen y mantienen la infraestructura en su conjunto.

Hay tres perfiles principales que deben tenerse en cuenta al diseñar la experiencia de desarrollo de una API:

• Consumidores de API – Descubren, implementan y mantienen integraciones de API para sus aplicaciones
• Propietarios de API – Planificar, crear, documentar, probar, desplegar y gestionar las API de sus servicios
• Responsables de infraestructura – Establecen políticas globales y supervisan las API para garantizar la seguridad y el cumplimiento normativo

Puede que deba tener en cuenta a otros usuarios y partes interesadas. Por ejemplo, la categoría de consumidores de API podría incluir subcategorías de desarrolladores internos, socios y clientes, cada una con perfiles y requisitos diferentes.

Paso 2: Definir la funcionalidad

La funcionalidad es la base del éxito de las API. Una buena API permite a los desarrolladores integrar datos o servicios valiosos, completar tareas con mayor rapidez y reducir el tiempo total dedicado al desarrollo de nuevas funcionalidades. Entre los aspectos clave que deben tenerse en cuenta se incluyen:

• ¿Qué valor aporta la API? al integrarse con datos o servicios?
• ¿Hasta qué punto resuelve la API el problema? reduciendo el número de llamadas y estructurando los datos?
• ¿Hasta qué punto es fiable la API en términos de disponibilidad, fiabilidad y escalabilidad?

La funcionalidad de una API está estrechamente ligada al enfoque de desarrollo «API-first». A diferencia del enfoque «code-first», con «API-first» la especificación de la API se redacta antes de comenzar a desarrollar el código, haciendo hincapié en la estructura de las solicitudes a la API y en los datos devueltos. Este énfasis garantiza que la API proporcione de forma sistemática el valor y la funcionalidad que necesitan los desarrolladores.

Paso 3: Optimiza la usabilidad

El tercer principio, la usabilidad, se centra en cómo utilizan los desarrolladores tus API, en lugar de en lo que pueden hacer con ellas. Abarca los recursos relacionados con tu API que facilitan su descubrimiento, aprendizaje, prueba e incorporación. Sin un ecosistema de infraestructura, herramientas y documentación que les sirva de apoyo, los desarrolladores tendrán dificultades para utilizar tus API. Entre los aspectos importantes que deben tenerse en cuenta se incluyen:

• Registro sencillo con inicio de sesión único (SSO) integrado y gestión sencilla de las claves de API
• Documentación clara y exhaustiva con referencias actualizadas y ejemplos de código
• Configuración rápida para crear una solicitud básica a la API, idealmente en menos de cinco minutos

En el informe sobre el estado de las API de 2022 de Postman, los encuestados señalaron que los principales obstáculos para consumir API son:

• Falta de documentación (55 %)
• Dificultad para descubrir APIs (38 %)
• Falta de conocimientos básicos sobre las API (30 %)

Puedes superar estos problemas utilizando portales centralizados para desarrolladores que incluyan documentación exhaustiva, ejemplos de código y herramientas para probar las API.

Paso 4: Mejora la experiencia

La experiencia del desarrollador con una API es el resultado de todas las interacciones entre el consumidor y el propietario de la API. Se basa en la funcionalidad y la facilidad de uso de la API, pero existen otras interacciones que contribuyen a que trabajar con ella resulte más satisfactorio. Entre ellas se incluyen:

• Comunidad activa disponible en canales como Stack Overflow, Slack, Discord, Twitter, etc.
• Soporte accesible con respuestas rápidas por parte de los equipos de desarrollo
• Experiencia sin complicaciones al interactuar con la API, la documentación y la comunidad

Los desarrolladores que disfrutan trabajando con tus API tienen más probabilidades de recomendárselas a sus compañeros, desarrollar nuevas funcionalidades en torno a ellas e integrarlas en sus aplicaciones.

La experiencia de los desarrolladores con las API es importante

La clave para ofrecer una excelente experiencia a los desarrolladores de API reside tanto en la propia API como en el ecosistema de herramientas, procesos, documentación y soporte que la rodea. Cuando todos los componentes del ecosistema de la API funcionan de forma fluida, se reducen las fricciones y la complejidad, lo que permite a los desarrolladores centrarse en crear aplicaciones.

Los pasos descritos anteriormente forman parte de un proceso continuo de diseño, implementación, pruebas y evaluación de la experiencia de desarrollo con la API. Si te centras en cada uno de los pasos principales —identificar a los usuarios, definir la funcionalidad, optimizar la usabilidad y mejorar la experiencia—, podrás crear API que resulten agradables e incluso divertidas de usar.

¿Cómo mejora NGINX la experiencia de los desarrolladores de API?

API Connectivity Manager, que forma parte de F5 NGINX Management Suite, se diseñó poniendo en el centro la experiencia de los desarrolladores de API. Con API Connectivity Manager, los equipos de infraestructura pueden implementar puertas de enlace de API de alto rendimiento y portales para desarrolladores. Además, los desarrolladores pueden publicar y gestionar rápidamente API y documentación, así como descubrir e integrar API en aplicaciones.

Entre las ventajas de API Connectivity Manager se incluyen:

• Incorporación rápida – Integre su proveedor de identidad preferido para agilizar la autorización y la autenticación en el portal para desarrolladores
• Documentación sencilla – Utilice la especificación OpenAPI para generar automáticamente la documentación del portal para desarrolladores cuando los propietarios de las API publiquen sus API en la puerta de enlace de API
• Aprendizaje interactivo – Permita que los desarrolladores descubran, prueben y aprendan a utilizar sus API mediante un explorador de API integrado en el portal para desarrolladores
• Automatización de flujos de trabajo – Integra la publicación y la gestión de API en tus canalizaciones de CI/CD mediante una API REST totalmente declarativa

Primeros pasos

Inicie una prueba gratuita de 30 días de NGINX Management Suite, que incluye API Connectivity Manager e Instance Manager.

Recursos relacionados

• Blog: Conecta, escala y protege aplicaciones y API con F5 NGINX Management Suite
• Blog: 5 formas de combatir la proliferación de API (y por qué debería importarte)
• Resumen de la solución: NGINX Management Suite API Connectivity Manager

Sobre el autor

Rajesh BavananthamDirector de Gestión de Producto | NGINX

Más artículos de Rajesh Bavanantham