Un punto final de API es un punto de conexión entre dos programas de software. Las API tienen puntos finales para cada recurso. Los puntos finales especifican la ubicación exacta de un recurso en el servidor.
Cuando una aplicación cliente solicita información del servidor, pasa por la API. Que luego accede a la solicitud y procesa una respuesta del servidor. Luego, la API transfiere la información solicitada desde el punto final a la aplicación.
Su API es eficiente si puede comunicarse de manera efectiva a través de sus puntos finales. Facilita a los usuarios el acceso a los recursos, mejorando la experiencia del usuario.
¿Cómo funciona un punto final de API?
Los sistemas integrados se comunican a través de API. Un sistema envía una solicitud a la API, utilizando un formato como SOAP o REST. El servidor recibe las solicitudes y transfiere la respuesta a la API. La ubicación de ese recurso solicitado es el punto final.
Antes de que un punto final procese una solicitud, el cliente debe proporcionar una URL, encabezados y un cuerpo. Los encabezados contienen metadatos sobre una solicitud y el cuerpo detalla los datos enviados al servidor. Un servidor también puede conectarse a una base de datos que métodos API puede acceder.
Los puntos finales de la API suelen funcionar con métodos HTTP como GET, DELETE, PATCH o POST. Los métodos determinan cómo usar un punto final. Cuando un cliente envía una solicitud, debe formularla para incluir el método de solicitud y la URL, por ejemplo:
CONSEGUIR https://example.com/books/authorsNombrar es difícil, ya sean puntos finales de API, dispositivos de hardware en red, o funciones y variables. Debe conocer algunas de las mejores prácticas que puede utilizar para asegurarse de que sus puntos finales de API sean un activo.
1. Usar una barra inclinada
Utilice siempre barras diagonales para separar los recursos de URI. Las barras también ayudan a mostrar la jerarquía de recursos. Lo siguiente es un ejemplo:
https://example.com/books/authors2. Use sustantivos, no verbos
Solo debe usar sustantivos para nombrar un recurso. Los sustantivos describen para qué sirve un recurso a diferencia de un verbo que describe lo que hace un recurso. Aquí hay un ejemplo de una buena y una mala manera de nombrar los puntos finales de la API.
Buen nombre:
https://example.com/api/getBooksMala denominación:
http://example.com/api/books3. Use sustantivos plurales, no singulares
Siempre debe nombrar sus puntos finales de API en sustantivos plurales. Esto le indica a un usuario que hay más de un recurso en el servidor. El uso de un sustantivo singular puede confundir al usuario haciéndole pensar que solo hay un recurso.
Buen nombre:
https://example.com/api/book/3Mala denominación:
http://example.com/api/books/34. Usar letras minúsculas
Debe escribir todas las URL en minúsculas. Esto incluye las URL de punto final de la API. Aquí hay un ejemplo:
Buen nombre:
http://example.com/api/Books/3Mala denominación:
http://example.com/api/books/35. Usar guiones para separar palabras
Use guiones para separar palabras combinadas. Los guiones resultan en frases más legibles que las mayúsculas y minúsculas o los guiones bajos. También son mejores para fines de SEO.
Buen nombre:
https://example.com/api/books/33/front_coverMala denominación:
https://example.com/api/books/33/front-cover6. No agregue extensiones de archivo
No necesita agregar una extensión de archivo a sus puntos finales de API. Aunque no afecta la salida, una extensión dificulta la lectura del recurso. También hace que el recurso sea menos flexible, rompiéndolo si la extensión cambia en el futuro.
Buen nombre:
https://example.com/api/books.xmlMala denominación:
https://example.com/api/books7. Incluir control de versiones
Siempre debe nombrar sus puntos finales de API de acuerdo con la versión. Esto es importante si está realizando cambios importantes en la API. Ayuda a diferenciar entre dos o más versiones de API de donde proviene el recurso. Puede indicar la versión al inicio del punto final.
Por ejemplo:
https://example.com/api/v3/books¿Por qué considerar las mejores prácticas de API?
Las API se han convertido en la columna vertebral de la programación moderna. Mejoran la colaboración, fomentan la innovación y mejoran la seguridad de las aplicaciones.
Ya sea que use nuevas herramientas o administre las existentes, las API simplifican el proceso. Por lo tanto, es esencial tener puntos finales que mejoren la experiencia del usuario. El nombre y la estructura de los puntos finales de su API determinan el rendimiento de su API.
Asegúrese de utilizar las mejores prácticas para crear puntos finales de API eficientes.
