Skip to content

SamuelCarmona83/Mi-Recetario-Azul

Repository files navigation

React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

Documentación de la API

  • init with npm run backend

  • psql -U postgres -h localhost

  • psql -U postgres -h localhost -c "CREATE DATABASE example;"

  • psql -U postgres -h localhost -c "DROP DATABASE example;"

Esta es la documentación de la API de Mi Recetario Rojo. A continuación se describen las rutas disponibles y los endpoints correspondientes.

Obtener Usuarios

Obtiene una lista de usuarios con sus atributos.

  • URL: /usuarios
  • Método: GET
  • Parámetros de consulta: Ninguno
  • Respuesta exitosa:
    • Código de estado: 200 OK
    • Contenido: Lista de usuarios con sus atributos (id, name y email).

Crear un Usuario

Crea un nuevo usuario.

  • URL: /usuarios
  • Método: POST
  • Cuerpo de la solicitud: Objeto JSON con los atributos del usuario (name, username,email y password).
  • Respuesta exitosa:
    • Código de estado: 201 Created
    • Contenido: Usuario recién creado con sus atributos.

Obtener Recetas de un Usuario

Obtiene una lista de recetas de un usuario específico.

  • URL: /usuarios/:username/recetas
  • Método: GET
  • Parámetros de ruta:
    • username (obligatorio): username del usuario del cual se desean obtener las recetas.
  • Respuesta exitosa:
    • Código de estado: 200 OK
    • Contenido: Lista de recetas con sus atributos.

Crear una Receta para un Usuario

Crea una nueva receta para un usuario específico.

  • URL: /usuarios/:username/recetas
  • Método: POST
  • Parámetros de ruta:
    • username (obligatorio): username del usuario para el cual se creará la receta.
  • Cuerpo de la solicitud: Objeto JSON con los siguientes atributos de la receta:
    • name (obligatorio): Nombre de la receta.
    • time (obligatorio): Tiempo estimado de preparación (en formato string).
    • descripcion (obligatorio): Descripción detallada de la receta.
    • image (obligatorio): URL o referencia de la imagen de la receta.
    • difficulty (obligatorio): Nivel de dificultad (en formato texto).
    • vegan (opcional): Indica si la receta es vegana (booleano).
    • spicy (opcional): Indica si la receta es picante (booleano).
    • fish (opcional): Indica si la receta contiene pescado (booleano).
    • meat (opcional): Indica si la receta contiene carne (booleano).
  • Respuesta exitosa:
    • Código de estado: 201 Created
    • Contenido: Receta recién creada con sus atributos.

Actualizar una Receta

Actualiza una receta existente.

  • URL: /recetas/:recipeId
  • Método: PUT
  • Parámetros de ruta:
    • recipeId (obligatorio): ID de la receta que se desea actualizar.
  • Cuerpo de la solicitud: Objeto JSON con los siguientes atributos de la receta a actualizar:
    • name (opcional): Nombre de la receta.
    • time (opcional): Tiempo estimado de preparación.
    • descripcion (opcional): Descripción detallada de la receta.
    • image (opcional): URL o referencia de la imagen.
    • difficulty (opcional): Nivel de dificultad.
    • vegan (opcional): Indica si la receta es vegana.
    • spicy (opcional): Indica si la receta es picante.
    • fish (opcional): Indica si la receta contiene pescado.
    • meat (opcional): Indica si la receta contiene carne.
  • Respuesta exitosa:
    • Código de estado: 200 OK
    • Contenido: Receta actualizada con sus atributos.

About

A Simple fullstack devcontainer web-app 📘

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors