Developer Experience
6
min de lectura
15 de septiembre de 2020

¿Cómo garantizar el éxito del consumo de las API?

Luciana Bandeira
Developer Experience
Ayudo a los desarrolladores con onboarding y las mejores prácticas de la API para garantizar la mejor Developer Experience . En mi tiempo libre me dedico a los libros, a investigar (y probar) postres y me apasiona viajar.
Más sobre el autor

Muchas acciones, que a veces pueden parecer incluso triviales, pueden realizarse para ayudar al desarrollador que está implementando el consumo de las API a utilizarlas correctamente, evitando así una sobrecarga de llamadas innecesarias e incorrectas, además de no comprender los flujos y acciones. A continuación se enumeran 10 pasos que pueden ayudar en el proceso de asegurar el consumo de las API y, por tanto, su uso de forma optimizada y exitosa.

10 pasos para asegurar el éxito del consumo de las API

  1. Extracción de métricas

La extracción de las métricas de uso de las solicitudes ejecutadas le permitirá conocer exactamente el volumen de uso y cuál es el porcentaje de errores X éxitos, además de identificar los principales problemas de las APP/desarrollo, el funcionamiento y el tipo de error, y, en consecuencia, implementar acciones para mejorar la experiencia y el uso.

  1. Alineación de error constante

Proporcionar feedback al desarrollador, con pruebas y directrices para los ajustes, permitirá alinear los escenarios de error, y suministrar información para solucionar los problemas. Asumiendo que el desarrollador comete errores debido a algún fallo en el proceso, es posible alinear lo antes posible de acuerdo con las evidencias y directrices para arreglar los errores internamente en el proceso de desarrollo.

  1. Monitorizar las llamadas de error ejecutadas

Además de extraer e identificar errores al utilizar las API, también es importante realizar una vigilancia constante. Así pues, será una acción eficaz para identificar la causa/razón de esos errores y también comprobar si el desarrollador ha hecho las correcciones necesarias. Esta acción también ayudará en el punto 2, en el que será posible recoger las pruebas de la alineación con el desarrollador y supervisar la usabilidad.

  1. Portal del desarrollador con documentación y aportaciones sobre la API

El Portal del Desarrollador es la entrada para el desarrollador que quiere consumir las APIs disponibles y debe ser a través de él que la información y las guías de usuario están disponibles.

  1. Documentación clara y elaborada en el Portal del Desarrollador

Esto apoyará todo el proceso de onboarding y hará que el entendimiento sea más claro. Un Dev Portal fácil de comunicar es aquel que contiene tanto lenguaje técnico como de negocios, para una mayor variedad de información.

  1. Inclusión de las mejores prácticas en el Dev Portal sobre el uso de la API, reglas de negocio, posibles HTTP Status

Parte de la información que creemos que es necesario incluir en el Dev Portal, ya que ayudará al desarrollador a comprender las reglas de manera más objetiva, y así poder incluir las reglas y la información en el propio desarrollo.

  1. Devuelva el mensaje con información de error clara y explicativa

Esto hará que sea más fácil para el desarrollador entender cuando ocurre un error. Exponer un mensaje amistoso cuando ocurre un error, además de estandarizar HTTP Status, ayudará al desarrollador a identificar más fácilmente los errores y sus causas.

  1. Desarrollo del reconocimiento de los rendimientos del lado del desarrollador

Por ejemplo, el desarrollador necesita identificar el error a través del mensaje de error http status + que se muestra, y tomar las medidas necesarias, evitando así la continuación del escenario repetidamente.

  1. Swagger con calidad

Un swagger muy detallado con la descripción de los campos, ejemplos de valores y todos los parámetros de consulta ayudará a los desarrolladores y reducirá el tiempo de "descubrimiento" del uso.

  1. Ambiente de prueba

Para simular los procesos que se ejecutarán/utilizarán en la producción. De esta manera, el desarrollador podrá realizar las pruebas necesarias y varias simulaciones, sin que ello afecte a su uso en el entorno de producción. Estos son algunos puntos a tener en cuenta en cuanto a la experiencia que los desarrolladores están teniendo al consumir sus API, ya sean abiertas o privadas. En Sensedia, disponemos de múltiples recursos que pueden ayudarle a tener más éxito con la distribución y las estrategias de onboarding en las API para garantizar que las mejores prácticas se están aplicando correctamente.

¡Gracias por leer!