REST es una forma simple de organizar interacciones entre
sistemas independientes. En teoría, REST no está vinculado a la
web, pero casi siempre se implementa como tal y se inspiró en
HTTP.
Una API REST define un conjunto de funciones que los
desarrolladores pueden realizar solicitudes y recibir respuestas a
través del protocolo HTTP, como GET y POST.
Requisitos clave para una API REST
Use URLs y acciones RESTful
Los principios clave de REST implican separar su API en
recursos lógicos. Una vez que haya definido sus recursos, debe
identificar qué acciones se aplican a ellos y cómo se
correlacionarían con su API.
Ejemplo
GET / tickets: recupera una lista de tickets
GET / tickets / 12 - Recupera un ticket específico
Una API es la interfaz de usuario de un desarrollador: al igual que
cualquier UI, es importante asegurarse de que la experiencia del
usuario se piense cuidadosamente.
Debe usar estándares web
donde tengan sentido
Debe ser amigable para el desarrollador y
ser explorable a través de una barra de
direcciones del navegador
Debe ser simple, intuitivo y consistente para hacer que la
adopción no solo sea fácil sino también agradable
Debe proporcionar suficiente flexibilidad para
impulsar la mayoría de la interfaz de usuario de
encantamiento.
Debe ser eficiente, manteniendo el equilibrio
con los otros requisitos
Cómo diseñar una API REST
En esta sección mostraremos como diseñar una
API REST para una aplicación basada en red.
Identificar el modelo de objeto
Para una aplicación basada en la red, el modelado de objetos es bastante más
simple. Tenga en cuenta que ambos objetos / recursos en nuestro modelo
anterior tendrán un identificador único, que es la propiedad de identificación.
Dispositivos
Configuraciones
Crear un modelo URI
Ahora que el modelo de objetos está listo, es hora de
decidir los URI de los recursos. En nuestra aplicación, un
dispositivo es un recurso de nivel superior.