Los secretos de un buen API ReST

Creación, Diseño y Arquitectura

API

Application Programming Interface

API ReST

- Representational State Transfer

- Protocolo HTTP

Características Principales

Simplicidad

Escalabilidad

Independiente

- Plataforma

- Lenguaje

Sin estados (Stateless)

Arquitectura (Web)

Proyecto

Construir un API ReST para un sistema de venta sencillo

Framework

Base de Datos

composer create-project jmanuelrp/laravel-bbmcore citec-pos-api --stability dev

¿Quién es el usuario de un API ReST?

¿Para quién se diseña?

Un API es creada por desarrolladores para desarrolladores  (•̀ᴗ•́)و

Richardson Maturity Model

Nivel 0

Uso del protocolo HTTP

Nivel 1

Recursos

  • Los nombres de URI no deben implicar una acción, por lo tanto debe evitarse usar verbos en ellos.
     
  • Deben ser únicas, no debemos tener más de una URI para identificar un mismo recurso.
     
  • Deben ser independiente de formato.
     
  • Deben mantener una jerarquía lógica.
     
  • Los filtrados de información de un recurso no se hacen en la URI.

Reglas

Nivel 2

HTTP

 

  • GET: Para consultar y leer recursos
     
  • POST: Para crear recursos
     
  • PUT: Para editar recursos
     
  • DELETE: Para eliminar recursos.
     
  • PATCH: Para editar partes concretas de un recurso.

Metodos

 

  • 1xx: Información
     
  • 2xx: Correcto
     
  • 3xx: Redirección
     
  • 4xx: Errores de sistema.
     
  • 5xx: Errores de servidor.

Códigos de estado

Incorrecto

Correcto

Nivel 3

Hipermedia

¡Gracias!

preguntas

jmanuel@apdevs.com

José Manuel Ruiz Pérez

Secretos de un buen API ReST

By JManuel Ruiz

Secretos de un buen API ReST

Taller de APIs durante el margen del CITEC 2017

  • 560