¿Qué es una
Rest API?
¡Todo lo que necesitas saber!
API
La API permite interacciones
entre sistemas al seguir un
conjunto de estándares y
protocolos para compartir
características, información y
datos.
Significado de API
A - Application
P - Programming
I - Interface
API
La API actúa como una interfaz entre
diferentes aplicaciones.
Diagrama
REST API
REST
Representational
State Transfer
Es un estilo de arquitectura
para desarrollar aplicaciones
web.
Utiliza el protocolo HTTP
como interfaz de
comunicación.
Transfiere datos a través de
los métodos HTTP.
Diagrama
Request anatomy
URL
Uniform Resource
Locator
Es la dirección que no solo identifica
un recurso, sino que también
especifica cómo acceder a él.
En una API, la URL puede denominarse
como URL Base, lo que significa que es
la dirección base que se usará en cada
solicitud.
Ejemplo: [Link]
Request anatomy
URI
Uniform Resource
Identifier
Se utiliza en la URL para especificar
qué recurso el cliente desea acceder
en una solicitud.
Ejemplo: [Link]
name=laptop&available=true
Aquí, el cliente le comunica URI
al servidor que la solicitud (resaltado en negro)
es para recuperar
productos con nombre
igual a "laptop" y
disponibilidad igual a "true".
Toda URL es un URI, pero no todos los URIs son URLs.
Body Params
El body de la solicitud que contiene
todos los datos que el servidor
necesita para procesar la solicitud
con éxito.
Solo se utiliza en solicitudes que deben enviar
información, como crear o actualizar.
Ejemplo
{
"name": "Laptop",
"price": 1000,
"available": true
}
Params
Información que puede ser enviada
en una solicitud por el cliente para
influir en la respuesta del servidor.
Tipos
Path param
Una variable en la ruta URI que
ayuda a señalar un recurso
específico.
[Link]
"1" es el parámetro de ruta (variable) que señala el
total de pedidos del restaurante número 1.
Query param
Una variable en la ruta URI que
ayuda a consultar o filtrar a
través de una lista de recursos.
[Link]
"name=cake" es el parámetro de consulta (variable)
que recupera los productos con el nombre "cake".
Headers
Permiten enviar información adicional
en una solicitud, como tokens de
autenticación y tipos de contenido.
Ejemplo
Authorization: Bearer token
Accept: application/json
En este ejemplo, el cliente está enviando
datos adicionales informando no solo sus
credenciales para acceder a un recurso, sino
también el formato de respuesta deseado.
Rest API Methods
5 Metodos
GET
Recibir información sobre
un recurso.
POST
Crear un recurso.
PUT
Actualizar un recurso.
DELETE
Eliminar un recurso.
PATCH
Modificar un recurso.
Http Status Codes
Con cada solicitud hecha al servidor,
recibimos un código de respuesta/códigos
de estado HTTP a cambio.
Status Codes
2XX: Éxito
3XX: Redirección
4XX: Problema con el cliente
5XX: Problema con el servidor
Seguime para
saber más
Recursos
& tips como
este.
Ignacio Oneto
@nachoneto