API Rest

logo_programacion

Una API REST (Representational State Transfer) es una forma de diseñar servicios web que permite la comunicación entre un cliente (frontend, Postman, otra API…) y un servidor mediante HTTP.

Es el tipo de API más utilizado en aplicaciones web modernas.

Principios REST

Una API REST bien diseñada cumple los siguientes principios:

  • Uso de métodos HTTP para definir acciones
  • URLs que representan recursos, no acciones
  • Stateless: el servidor no guarda estado entre peticiones
  • Formato JSON como estándar de intercambio de datos

Métodos HTTP más comunes

MétodoUso
GETObtener datos
POSTCrear un recurso
PUTActualizar un recurso completo
PATCHActualizar parcialmente
DELETEEliminar

Ejemplo de recursos

Un recurso representa una entidad del sistema:

  • /users
  • /products
  • /orders

Incorrecto:

/getUsers
/createUser

Correcto:

GET /users
POST /users

Ejemplo de endpoints REST

MétodoRutaAcción
GET/usersObtener todos
POST/usersCrear usuario
GET/users/:idObtener uno
PUT/users/:idActualizar
DELETE/users/:idEliminar

Ejemplo de controlador

exports.getUsers = async (req, res) => {
  const users = await User.find();
  res.status(200).json(users);
};

Códigos de estado HTTP

Usar correctamente los códigos de estado es parte de REST:

  • 200 OK
  • 201 Created
  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 500 Internal Server Error