Header Ads Widget

Ticker

6/recent/ticker-posts

Por qué la experiencia del desarrollador de API es más importante que nunca

 

Concepto plano de vector de idea de negocio.  Motivación e inspiración

Es interesante hablar de cómo la mejora de la experiencia del usuario de la API puede hacer felices a los usuarios finales. Es importante tener en cuenta la experiencia de usuario con las API y con cualquier tipo de desarrollo. Pero a veces nos olvidamos de los intermediarios, que a menudo son la verdadera audiencia y los clientes previstos. Al desarrollar una interfaz de programación de aplicaciones, o API, es fundamental mantener la experiencia del desarrollador o DX como una prioridad en todo lo que hacemos.

¿Qué es la experiencia del desarrollador?

Primero, veamos la experiencia del usuario (UX) en general. UX considera la experiencia general que tiene una persona con una aplicación móvil o un sitio web. Esta actitud puede ser positiva o negativa dado el valor y la facilidad de las interacciones entre humanos y computadoras.

La experiencia del desarrollador es una extensión de UX que se centra en el desarrollador, que puede ser el intermediario o, como es el caso de muchas API, el usuario final . Ya sea que se enfoque o no en el diseño DX, sus desarrolladores siempre están experimentando su API, y esa experiencia puede ser positiva o negativa.

No hay duda de que las API están impulsando nuestro mundo móvil e integrado. Las aplicaciones y los sitios web buscan utilizar API para atraer clientes y escalar rápidamente. En este agitado proceso, los proveedores de API desafortunadamente están perdiendo de vista la calidad de la experiencia del desarrollador.

Ronnie Mitra

Ronnie Mitra - Evangelista DX

Una persona ha pasado años tratando de llamar nuestra atención sobre DX. Ronnie Mitra es el director de diseño de API en API Academy , que se centra en las mejores prácticas de diseño e implementación de API. Hablando de desarrolladores, Mitra escribe: " Si su API está mal diseñada , mal documentada y mal soportada y no están obligados a usarla, puede apostar que no lo harán ". Si mejoramos la experiencia que tienen los desarrolladores mientras trabajan con API, Mitra argumenta que esto puede mejorar drásticamente las tasas de uso. En este artículo, describimos las formas en que Mitra y otros influencers de API han trabajado para hacer precisamente eso.

¿Qué es una mala experiencia de desarrollador de API?

Mitra inició su charla en la conferencia de APIs nórdicas en Estocolmo con un tartamudeo monótono, mirando las feas diapositivas de Windows 95 de espaldas a la audiencia. El orador dinámico hizo esto para recordar cómo la información, sin importar cuán útil sea, no se consumirá si la experiencia no se presenta bien, no está bien estructurada y no es interactiva.

Ronnie Mitra de CA API Management se presentó en las API nórdicas en Estocolmo, septiembre de 2013.

¿Debe el diseño de API centrarse en la funcionalidad, la usabilidad o la experiencia?

Mitra sostiene que hay tres concentraciones a menudo aisladas de diseño de API:

La funcionalidad como factor de diseño : esto fue lo que siguió en la época de la arquitectura orientada a servicios; diseñando para la función y enfocándose en qué actividades y acciones deben suceder. ¿Qué hace la API? ¿Donde está localizado? ¿Qué tan confiable es la implementación?

La usabilidad como factor de diseño : este es el enfoque de la mayoría de los diseños de API contemporáneos. “Solíamos centrarnos más en los servicios y ahora nos centramos más en los desarrolladores. Nos preocupamos por los usuarios ”, explicó. Sin embargo, advierte que “la utilidad sigue triunfando sobre la usabilidad. No importa qué tan utilizable sea su producto, si no hace lo que nadie quiere, a nadie le importará ".

La experiencia como factor de diseño : ¿cómo hace sentir la API al desarrollador? Mitra define DX como la suma de todas las interacciones entre usted y el desarrollador, y cómo se siente el desarrollador sobre esas interacciones.

La interacción de los tres se combina para hacer (o deshacer) la experiencia del desarrollador. A pesar de que estamos construyendo software para que otras personas construyan software, todavía estamos construyendo una línea de comunicación: el punto humano de esta interacción abstracta. Mitra sostiene que para diseñar para la usabilidad, los proveedores primero deben comprender a su audiencia por dentro y por fuera.

Cómo medir la usabilidad de la API

Podría preguntarse cómo se puede medir algo tan intangible como la interacción y la experiencia humanas. Para llegar allí, primero debe investigar a su desarrollador de destino para construir una persona para un consumidor típico de cada API. Según Mitra, no es el simple "perfil de Apple Genius" que normalmente imagina que es.

Considere estas preguntas que un diseñador de API puede intentar responder para determinar si su API es utilizable, desde la perspectiva del desarrollador:

  • Relación de invocación de tareas : ¿cuántas llamadas a la API se necesitan para lograr cada objetivo?
  • Estructura : ¿Cuál es la estructura de la solicitud y la respuesta? ¿Qué tan profundo tiene que llegar un desarrollador para obtener lo que quiere?
  • Navegación : ¿Cuánto ruido hay? ¿Qué tan difícil es mover los datos que quieren?
  • Tamaño de pila de desarrollador : ¿Cuántas herramientas y bibliotecas adicionales necesita instalar un desarrollador para utilizar su API?
  • Hora de la primera llamada : ¿Qué tan rápido puede un nuevo usuario realizar la primera llamada a la API?
  • Manejo de errores : ¿Cuál es la naturaleza de los errores que están ocurriendo? ¿Qué tan difíciles son de arreglar? ¿De quién es la culpa? ¿Dónde están sucediendo?
  • Vocabulario : ¿Qué necesita saber un desarrollador para utilizar su API fácilmente?

Estas preguntas de usabilidad deben aplicarse a las personas que ha establecido. Solo entonces puede comenzar a desarrollar respuestas a los rasgos subjetivos que conforman la experiencia, como el compromiso, el placer, la familiaridad y la percepción de confianza y seguridad. Las estadísticas que miden la usabilidad junto con el conocimiento de la experiencia del usuario se combinan en un intento de cuantificar la experiencia del desarrollador.

Utilice una auditoría de API para mejorar DX

Mitra sugiere que la estrategia comercial y los objetivos de diseño que responden a la experiencia del desarrollador siempre tendrán más éxito que una API lanzada al mercado para la opinión pública.

El ingeniero de software e integrador líder, Raúl Pérez,  recomienda realizar una auditoría de API antes de abrirla a los desarrolladores del mundo. Debes "comer tu propia comida para perros" probando tu API para encontrar fallas antes que tu usuario. Pérez nos da los pasos para realizar una auditoría interna de API:

  1. Vaya más allá de CRUD : crear, leer, actualizar y eliminar es un buen comienzo, pero es ineficiente por sí solo. Necesita trabajar con múltiples fuentes de datos al mismo tiempo, mejorando el filtrado y agregando funcionalidad de búsqueda adicional.
  2. Multitarea : intente trabajar con muchos elementos a la vez. Si su API es lenta o se acelera (tiene un límite de velocidad de API), diséñela de modo que una llamada pueda devolver una lista de elementos.
  3. Filtrar resultados : considere cómo el consumidor prefiere que se estructuran sus datos. Piense en filtros comunes que un usuario pueda desear. Pruébelos. Tener filtros para cada recurso puede reducir drásticamente la cantidad de resultados que la API proporcionará para las consultas más comunes.
  4. Asegúrese de incluir una búsqueda de API : si bien un filtro puede ser limitado, una búsqueda le permite trabajar con porciones o con más de uno de los valores de estos campos a la vez. Pérez cree que una API con capacidad de búsqueda es el epítome de una API amigable para los desarrolladores.

La documentación de la API lo ayuda a diseñar y desarrollar pensando en el usuario

Para la documentación de API centrada en el ser humano, Mitra argumenta que debe identificar diferentes niveles de experiencia en lectores de API . Esto puede variar desde un visitante por primera vez que siente curiosidad por la funcionalidad básica, hasta un desarrollador experimentado interesado en el fundamento de las decisiones de diseño, el rendimiento y la escalabilidad.

La documentación de la API debe ser accesible para estas distintas audiencias en un estilo consumible con ejemplos efectivos. Incluso se ha demostrado que la documentación adecuada de API enciende las tasas de adopción de API . Entonces, ¿qué hace que la documentación sea valiosa?

  1. Fragmentos : pequeño fragmento de código o interacción que se ofrece para ilustrar un concepto descrito en el texto.
  2. Tutoriales : recorrido paso a paso de tareas complejas o populares
  3. Aplicación : ofreciendo el código fuente de los clientes API actuales como ejemplo
Consulte este artículo para obtener más información sobre el diseño de API basado en documentación

Diseñar primero la API ayuda a mantener la experiencia del desarrollador en primer lugar

La práctica hasta ahora ha sido diseñar un sitio web o una aplicación y luego construir una API. Una forma de diseñar una API teniendo en cuenta al usuario es diseñar la API primero.

El "enfoque de diseño de API primero ayuda mucho a estructurar internamente su sistema y arquitectura de TI, y también le ayuda a mantener mejor su arquitectura", dijo Manfred Bortenschlager, director de desarrollo de mercado de API en 3scale.net .

Al comer su propia comida para perros, las organizaciones maximizan la eficiencia de la API y continúan mejorando una API internamente. Hace unos 12 años, Amazon Web Services, pioneros de la API web, hizo que las unidades de negocio internas solo pudieran comunicarse a través de API. Esto condujo a una mejor experiencia de desarrollador de API y a una innovación generalizada.

Al definir primero la API, naturalmente garantiza una mejor experiencia para el desarrollador, ya que todo lo que haga se basará en ella. Hacer que una API esté disponible desde el principio también puede actuar como una fuente de ingresos adicional inmediata  , una forma de aumentar el conocimiento y la eficiencia de la marca y, al igual que con AWS, una forma de fomentar la innovación abierta dentro de su empresa y con los desarrolladores de usuarios finales.

Conclusión

Al diseñar una API, debe recordar constantemente que si su API está mal diseñada, documentada o respaldada, nadie la usará a menos que se vea obligado a hacerlo.

Antes de diseñar una mejor experiencia de desarrollador, primero debemos responder:

  1. ¿Para quién lo diseñamos?
  2. ¿Por qué lo estamos diseñando?
  3. ¿Cuáles son las limitaciones?

El diseño de API debe centrarse en una combinación de funcionalidad, usabilidad y experiencia de desarrollador. La usabilidad debe medirse a través de una auditoría de API y luego mediante el seguimiento de las acciones que realizan los usuarios desarrolladores. El diseño de API primero es una forma en particular en la que puede enfocarse en la experiencia del desarrollador desde cero, ya que usted desempeña el papel de desarrollador con cada acción de diseño que realiza.

Mitra también aboga por que tal vez debería comenzar a asistir a conferencias de desarrolladores en lugar de conferencias de usuarios para comenzar a conectarse con sus usuarios finales. Por supuesto, en las API nórdicas, creemos que debería ir a ambas. Continúe esta discusión en uno de nuestros próximos eventos en Copenhague, Munich, Londres y Seattle .

Ahora, cuéntenos, ¿cómo está diseñando API teniendo en cuenta la experiencia del desarrollador?

Publicar un comentario

0 Comentarios