Developer Experience
5
min de lectura
28 de julio de 2020

Buenas prácticas: Las API y sus métodos

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

Como ya sabrá, una API es una comunicación simplificada y directa entre el desarrollador y su empresa, segura y fácil de usar. Los métodos de uso de la API pueden abarcar formas de pago, marketplaces, beneficios, comunicación y tráfico entre los sistemas internos y otros varios. Su enfoque se basa esencialmente en el siguiente ejemplo ilustrado:

Ya hemos hablado de algunas buenas prácticas en el uso de las APIs que incluso abordan los buenos usos y el entendimiento entre el desarrollador y sus APIs, como la importancia del uso correcto de HTTP Status (entre varias entradas e informaciones que encontrarás en nuestro blog), y hoy hablaremos de los métodos de las APIs. Aunque es un tema muy claro para todos los que ya conocen y utilizan las APIs, las personas más legas en la materia (pero que aún quieren conocer y aprender a utilizarlas) pueden acabar teniendo alguna duda sobre este tema.

Las operaciones siguen los estándares del protocolo HTTP para el procesamiento de llamadas y definen la acción esperada para cada uno de los métodos de uso de la API.

Métodos de uso de la API:

  • Get (Data query/search)

Este método permite buscar información/datos según el recurso y el punto final introducido. También se puede (y se debería) utilizar este método junto con los filtros de recursos y la paginación. A través de este método, el backend devolverá la información consultada.

  • Post (Data sending/loading)

Crear/ejecutar un montón de nueva información en la base. Es necesario enviar la información en la norma JSON requerida en el cuerpo de la solicitud.

  • Put and Patch (Actualización de datos)

Se utiliza para actualizar o editar la información que ya existe en la base. Algunos API contemplan o no el uso de Patch (indicado para actualizaciones parciales), y el uso de Put es ampliamente conocido y el responsable de cambiar/actualizar la información existente.

  • Delete (Borrar datos)

Como su nombre indica, es el método responsable de borrar la información. Se trata de un punto importante que sólo se incluye en la API si, para la regla de negocio, es necesario excluir información de la base (y si está permitido). Algunas empresas no permiten este uso, porque es una acción que borrará definitivamente el registro particular. ¿Qué le parecieron los métodos de uso de la API? ¿Ya los conocía?

¡Gracias por leer!