/kata-API-cervezas

Kata : crear una API de cervezas para practicar el desarrollo de una API y entender las peticiones HTTP

MIT LicenseMIT

Note Si alguien quiere usar docker, docker-compose, adelante. Pero ahora mismo no es nuestro objetivo. Los objetivos son los que aparecen tras ### Objetivos del módulo

Kata API

Kata : crear una API funcional CRUD sobre varias tablas en MySQL.

Objetivo

Creación y utilización de una API y aprender y usar diferentes métodos HTTP. Además de trabajar con Docker en un proyecto.

Prerrequisitos

En la Kata se asume familiaridad con las siguientes tecnologías Git, Docker y Docker-compose.

Procedimiento

Hacer un fork del repositorio, crear una rama (git checkout -b username/langage por ejemplo git checkout -b nicolasreymond/php, desde vuestro fork). Haced un pull request para añadirlo a este repo y añadiéndoos al final de este fichero como autores.

Puesta en marcha

En cada cambio de un fichero en el contenedor tenemos que hacer:

docker-compose up --build

Y para lanzar los contenedores:

docker-compose up -d

Objetivos de la Kata

  • Hacer un fork del repositorio Git
  • Crear una nueva rama (ex. : usermame/language)
  • Añadir un contenedor docker (para el lenguage elegido) al docker-compose (NO ES NECESARIA ESTA PARTE)

Objetivos del módulo

  • Comprender cómo detectar las diferentes peticiones HTTP (GET, POST, PUT, PATCH, DELETE)
  • Implementación del CRUD sobre el endpoint /beer*
    • Implementar la creación Create
    • Implementar la lectura Read
    • Implementar la actualilzación Update
    • Implementar el borrado Delete
  • Implementar la lectura de los endpoints /brewerie*, /categorie* et /style*
  • Probar la API con
  • Hacer un documento que explique cómo utilizar la API (con ejemplos de cada una de las consultas)

Ir más lejos

  • Implementar la paginación para consultar que devuelven muchos datos por ejemplo con el método HTTP HEAD. HEAD
  • Integración con swagger del lenguaje escogido.
  • Modificaciones para poder subir imágenes de las cervezas

Descripción de rutas a utilizar

Endpoint Resultado Método
/beers Muestra todas las cervezas GET
/beer Añadir una cerveza POST
/beer/{id} Mostrar la cerveza con el id {id} GET
/beer/{id} Eliminar una cerveza DELETE
/beer/{id} Modificar una cerveza PUT
/beer/{id} Modificar parcialmente una cerveza PUT o PATCH
/breweries Listar todas las cerveceras GET
/brewerie/{id} Mostrar la cervecera {id} GET
/categories Listar todas las categorías GET
/categorie/{id} Mostrar la categoría {id} GET
/styles Listar todos los estilos -style- GET
/style/{id} Mostrar el estilo -style- {id} GET

Colaboradores (idiomas en orden alfabético)

Laravel → saphirevert-repos