Why the API Developer Experience Matters (Por qué es importante la experiencia del desarrollador de API)
Esta es la segunda publicación de una serie de dos partes sobre API Connectivity Manager:
- 5 maneras de combatir la proliferación de APIs (y por qué debería importarte)
- Por qué es importante la experiencia del desarrollador de API: esta publicación
Las API están en el centro de los negocios modernos. Si bien las API siempre han desempeñado un papel importante en el desarrollo de software, la creciente demanda de integración de datos está llevando a una adopción más amplia de las API en todas las líneas de negocio. Pero las API hacen más que simplemente conectar datos y aplicações : son fundamentales para colaborar con socios comerciales externos, brindar 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 API. Responsables de crear, integrar y mantener las API, son tanto los creadores como los adoptantes técnicos de las API. Su experiencia, comúnmente denominada experiencia de desarrollador de API , es uno de los factores más importantes para determinar el éxito general de una API. Esta publicación explora los conceptos clave de la experiencia de desarrollador de API y lo que los líderes de TI deben considerar al planificar la experiencia de API.
- ¿Qué es la experiencia del desarrollador de API?
- ¿Por qué es importante la experiencia del desarrollador API?
- ¿Cómo crear excelentes experiencias para desarrolladores de API?
¿Qué es la experiencia del desarrollador de 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 una experiencia agradable y fluida para los desarrolladores que integran API en sus aplicações. La experiencia del desarrollador de API es una subpráctica de la experiencia general del desarrollador.
¿Por qué es importante la experiencia del desarrollador API?
Si un enfoque incansable en la experiencia del usuario impulsó la primera generación de innovación tecnológica, entonces la próxima generación de empresas exitosas ganará con un enfoque en la experiencia del desarrollador .
A medida que la economía de API continúa expandiéndose, los desarrolladores están ganando mayor influencia sobre qué API se adoptan. Cuando una API es difícil de descubrir, carece de documentación adecuada o está mal mantenida, los desarrolladores la abandonarán en favor de una alternativa más simple 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, existen consecuencias comerciales tangibles cuando los desarrolladores abandonan su API. No solo pierde ingresos de clientes directos, sino que también pierde acceso al ecosistema más amplio de productos y soluciones que utilizan sus clientes. Incluso los programas de API internos enfrentan consecuencias por una mala experiencia del desarrollador, incluyendo tiempos de comercialización más lentos, menor productividad del desarrollador y mayor repetición del trabajo, lo que potencialmente pone en peligro el éxito de su negocio.
Para triunfar en el mundo centrado en el desarrollador, necesita una estrategia de API que proporcione las herramientas y los recursos adecuados para los desarrolladores que trabajan en cada etapa del ciclo de vida de la API. La mejor manera de lograr esto es crear una experiencia de API integral y bien pensada para los desarrolladores que abarque tres tipos de uso de API:
- Implementación y gestión de API
- Descubrimiento y prueba de API
- Monitoreo y protección de API
¿Cómo crear excelentes experiencias para desarrolladores de API?
Crear una experiencia positiva implica comprender cómo los desarrolladores usan tu API, qué necesitan para completar sus tareas y, en definitiva, cómo se sienten al usarla. Una vez definidas las personas que interactuarán con tus API, puedes empezar a planificar la experiencia API completa.
Hay cuatro principios a tener en cuenta al diseñar la experiencia del desarrollador de API:
- Identificar a los usuarios : ¿quién interactúa con la API?
- Definir funcionalidad : ¿Qué hace la API?
- Optimizar la usabilidad : ¿Qué tan fácil es utilizar la API?
- Mejorar la experiencia : ¿Qué se siente al utilizar la API?
Analicemos cada principio y lo que debe proporcionar para crear una experiencia de API óptima para los desarrolladores.
Paso 1: Identificar usuarios
Así como diseña productos para problemas específicos de los clientes, necesita diseñar la experiencia de API en toda su infraestructura y productos para abordar las inquietudes de los desarrolladores. Los desarrolladores son más que el consumidor final: también son los constructores y mantenedores de la infraestructura general.
Hay tres personas principales a tener en cuenta al diseñar una experiencia de desarrollador de API:
- Consumidores de API : descubran, implementen y mantengan integraciones de API para sus aplicações
- Propietarios de API : planifican, crean, documentan, prueban, implementan y administran API para sus servicios
- Administradores de infraestructura : establezcan políticas globales y supervisen las API para garantizar la seguridad y el cumplimiento.
Es posible que haya usuarios y partes interesadas adicionales que deba considerar. Por ejemplo, la categoría de consumidores de API podría incluir subcategorías de desarrolladores internos, socios y clientes, cada uno con diferentes personalidades y requisitos.
Paso 2: Definir funcionalidad
La función es la base de las API exitosas. Una buena API permite a los desarrolladores integrarse con datos o servicios valiosos, completar tareas más rápido y reducir el tiempo total dedicado al desarrollo de nuevas funciones. Las consideraciones clave incluyen:
- ¿Qué valor aporta la API al integrarse con datos o servicios?
- ¿Qué tan bien resuelve la API el problema al reducir las llamadas y estructurar los datos?
- ¿Qué tan confiable es la API en términos de disponibilidad, confiabilidad y escalabilidad?
La funcionalidad de una API está estrechamente relacionada con el enfoque API-first para el desarrollo. A diferencia de “código primero”, con “API primero” la especificación de la API se escribe antes de que comience el desarrollo del código, con énfasis en la estructura de las solicitudes de la API y los datos devueltos. Este énfasis garantiza que la API ofrezca consistentemente el valor y la funcionalidad que los desarrolladores necesitan.
Paso 3: Optimizar la usabilidad
El tercer principio, usabilidad, aborda cómo los desarrolladores utilizan sus API, en lugar de lo que pueden hacer con ellas. Cubre los recursos alrededor de su API que respaldan el descubrimiento, el aprendizaje, las pruebas y la incorporación. Sin un ecosistema de apoyo de infraestructura, herramientas y documentación, los desarrolladores tendrán problemas para usar sus API. Las consideraciones importantes incluyen:
- Registro sencillo con inicio de sesión único (SSO) integrado y fácil gestión de claves API
- Documentación clara y completa con referencias actualizadas y ejemplos de código.
- Tiempo de configuración rápido con creación de una solicitud de API básica que idealmente toma menos de cinco minutos
En el Informe sobre el estado de las API de 2022 de Postman, los encuestados afirmaron que los principales obstáculos para consumir API son:
- Falta de documentación (55%)
- Problemas para descubrir API (38%)
- Falta de conocimientos fundamentales de API (30%)
Puede superar estos problemas aprovechando los portales centrales para desarrolladores con documentación completa, ejemplos de código y herramientas para probar las API.
Paso 4: Mejorar la experiencia
La experiencia del desarrollador de API es la suma de las interacciones entre el consumidor de API y el propietario de API. La base se basa en la funcionalidad y la usabilidad de la API, pero existen interacciones adicionales que contribuyen a la experiencia de trabajar con ella. Estas pueden incluir:
- Comunidad activa disponible en canales como Stack Overflow, Slack, Discord, Twitter, etc.
- Soporte accesible con respuestas oportunas de los equipos de desarrollo.
- Experiencia sin fricciones al interactuar con la API, la documentación y la comunidad
Los desarrolladores que disfrutan trabajando con sus API tienen más probabilidades de recomendarlas a sus colegas, crear nuevas capacidades en torno a ellas y integrarlas en sus aplicaciones.
La experiencia del desarrollador de API es importante
La clave para una excelente experiencia como desarrollador de API incluye su API, así como el ecosistema de herramientas, procesos, documentación y soporte que la rodea. Cuando todas las piezas de su ecosistema API funcionan sin problemas, reducen la fricción y la complejidad para que los desarrolladores puedan concentrarse en crear aplicações.
Los pasos analizados anteriormente son parte de un proceso continuo de diseño, implementación, prueba y evaluación de la experiencia del desarrollador de API. Si te concentras en cada uno de los pasos principales (identificar usuarios, definir la funcionalidad, optimizar la usabilidad y mejorar la experiencia), puedes crear API que sean agradables e incluso divertidas de usar.
¿Cómo mejora NGINX la experiencia del desarrollador de API?
API Connectivity Manager , parte de F5 NGINX Management Suite , fue diseñado teniendo como núcleo la experiencia del desarrollador de API. Con API Connectivity Manager, los equipos de infraestructura pueden implementar puertas de enlace de API y portales para desarrolladores de alto rendimiento. Además, los desarrolladores pueden publicar y gestionar rápidamente API y documentación o descubrir e integrar API en las aplicações.
Los beneficios de API Connectivity Manager incluyen:
- Incorporación rápida : intégrelo con su proveedor de identidad favorito 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 documentación para el portal para desarrolladores cuando los propietarios de API publiquen API en la puerta de enlace de API.
- Aprendizaje interactivo : permita que los desarrolladores descubran, prueben y aprendan sus API con un explorador de API integrado en el portal para desarrolladores
- Automatización del flujo de trabajo : integre la publicación y la gestión de API en sus pipelines de CI/CD mediante una API REST totalmente declarativa
Introducción
Comience una prueba gratuita de 30 días de NGINX Management Suite , que incluye API Connectivity Manager y Instance Manager .
Recursos relacionados
"Esta publicación de blog puede hacer referencia a productos que ya no están disponibles o que ya no reciben soporte. Para obtener la información más actualizada sobre los productos y soluciones F5 NGINX disponibles, explore nuestra familia de productos NGINX . NGINX ahora es parte de F5. Todos los enlaces anteriores de NGINX.com redirigirán a contenido similar de NGINX en F5.com.