Giter VIP home page Giter VIP logo

api-cookin's Introduction

JSON Server React da API Cookin'

Endpoints

A url base da API é https://api-cookin.herokuapp.com

Rotas que não precisam de autenticação


Usuários

Cadastro de usuário

POST /register - FORMATO DA REQUISIÇÃO - STATUS 201

{
  "name": "Philipe Compê",
  "email": "[email protected]",
  "sexo": "m",
  "password": "123456"
}

Caso dê tudo certo, a resposta será assim:

POST /login - FORMATO DA RESPOSTA - STATUS 201

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InBjb21wZUBlbWFpbC5jb20iLCJpYXQiOjE2MzY0ODU0NjEsImV4cCI6MTYzNjQ4OTA2MSwic3ViIjoiMiJ9.CcAbGr4YPxgvTVrfadAuibSFFTOVP15CLB6LnAwVmLU",
  "user": {
    "email": "[email protected]",
    "name": "Philipe Compê",
    "sexo": "m",
    "id": 2
  }
}

Login

POST /login - FORMATO DA REQUISIÇÃO - STATUS 201

{
  "email": "[email protected]",
  "password": "123456"
}

Caso dê tudo certo, a resposta será assim:

POST /login - FORMATO DA RESPOSTA - STATUS 201

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InBjb21wZUBlbWFpbC5jb20iLCJpYXQiOjE2MzY0ODU2NTAsImV4cCI6MTYzNjQ4OTI1MCwic3ViIjoiMiJ9.bshw8mx1ZvLIaW56DOF34NsxFpsCXqBlJ9xy4_BakuQ",
  "user": {
    "email": "[email protected]",
    "name": "Philipe Compê",
    "sexo": "m",
    "id": 2
  }
}

Rotas que precisam de autenticação

Rotas que necessitam de autorização deve ser informado no cabeçalho da requisição o campo "Authorization", dessa forma:

Authorization: Bearer {token}

Após o usuário estar logado, ele deve conseguir acessar os endpoints abaixo:


Receitas Particulares

Adicionar Receitas Particulares

POST /myrecipes - FORMATO DA REQUISIÇÃO - STATUS 201

{
  "title": "Bolo de Laranja Vegano",
  "ingredients": [
    "1 laranja em cubos",
    "1/2 xícara de suco de laranja",
    "3/4 de xícara de óleo",
    "1 xícara de açúcar",
    "2 xícaras de farinha de trigo",
    "1 colher de sopa de fermento em pó",
    "Pitada de sal"
  ],
  "instructions": [
    "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
    "Misturar em uma tigela a farinha e o fermento em pó.",
    "Incorporar a mistura do liquidificador na farinha com o fermento.",
    "Colocar a massa em uma forma untada e enfarinhada.",
    "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
  ],
  "category": "doce",
  "author": "Mark",
  "userId": "1"
}

Caso dê tudo certo, a resposta será assim:

{
  "title": "Bolo de Laranja Vegano",
  "ingredients": [
    "1 laranja em cubos",
    "1/2 xícara de suco de laranja",
    "3/4 de xícara de óleo",
    "1 xícara de açúcar",
    "2 xícaras de farinha de trigo",
    "1 colher de sopa de fermento em pó",
    "Pitada de sal"
  ],
  "instructions": [
    "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
    "Misturar em uma tigela a farinha e o fermento em pó.",
    "Incorporar a mistura do liquidificador na farinha com o fermento.",
    "Colocar a massa em uma forma untada e enfarinhada.",
    "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
  ],
  "category": "doce",
  "author": "Mark",
  "userId": "1",
  "id": 1
}

Ver Receitas Particulares

GET /myrecipes - FORMATO DA RESPOSTA - STATUS 200

Caso dê tudo certo, a resposta será assim:

[
  {
    "title": "Bolo de Laranja Vegano",
    "ingredients": [
      "1 laranja em cubos",
      "1/2 xícara de suco de laranja",
      "3/4 de xícara de óleo",
      "1 xícara de açúcar",
      "2 xícaras de farinha de trigo",
      "1 colher de sopa de fermento em pó",
      "Pitada de sal"
    ],
    "instructions": [
      "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
      "Misturar em uma tigela a farinha e o fermento em pó.",
      "Incorporar a mistura do liquidificador na farinha com o fermento.",
      "Colocar a massa em uma forma untada e enfarinhada.",
      "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
    ],
    "category": "doce",
    "author": "Mark",
    "userId": "1",
    "id": 1
  }
]

Deletar Receitas Particulares

DELETE /myrecipes/${myrecipeID} - FORMATO DA RESPOSTA - STATUS 200

Este endpoint não possui resposta


Editar Receitas Particulares

PATCH /myrecipes/${myrecipeID} - FORMATO DA REQUISIÇÃO - STATUS 201

{
  "title": "Bolo de Maçã Vegano",
  "ingredients": [
    "1 maçã em cubos",
    "1/2 xícara de suco de laranja",
    "3/4 de xícara de óleo",
    "1 xícara de açúcar",
    "2 xícaras de farinha de trigo",
    "1 colher de sopa de fermento em pó",
    "Pitada de sal"
  ],
  "instructions": [
    "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
    "Misturar em uma tigela a farinha e o fermento em pó.",
    "Incorporar a mistura do liquidificador na farinha com o fermento.",
    "Colocar a massa em uma forma untada e enfarinhada.",
    "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
  ],
  "category": "doce",
  "author": "Mark",
  "userId": "1",
}

Caso dê tudo certo, a resposta será assim:

{
  "title": "Bolo de Laranja Vegano",
  "ingredients": [
    "1 laranja em cubos",
    "1/2 xícara de suco de laranja",
    "3/4 de xícara de óleo",
    "1 xícara de açúcar",
    "2 xícaras de farinha de trigo",
    "1 colher de sopa de fermento em pó",
    "Pitada de sal"
  ],
  "instructions": [
    "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
    "Misturar em uma tigela a farinha e o fermento em pó.",
    "Incorporar a mistura do liquidificador na farinha com o fermento.",
    "Colocar a massa em uma forma untada e enfarinhada.",
    "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
  ],
  "category": "doce",
  "author": "Mark",
  "userId": "1",
  "id": 1
}

Receitas Públicas

Adicionar Receitas Públicas

POST /recipes - FORMATO DA REQUISIÇÃO - STATUS 201

{
  "title": "Bolo de Maçã Vegano",
  "ingredients": [
    "1 maçã em cubos",
    "1/2 xícara de suco de laranja",
    "3/4 de xícara de óleo",
    "1 xícara de açúcar",
    "2 xícaras de farinha de trigo",
    "1 colher de sopa de fermento em pó",
    "Pitada de sal"
  ],
  "instructions": [
    "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
    "Misturar em uma tigela a farinha e o fermento em pó.",
    "Incorporar a mistura do liquidificador na farinha com o fermento.",
    "Colocar a massa em uma forma untada e enfarinhada.",
    "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
  ],
  "category": "doce",
  "author": "Mark",
  "favorites_users": [],
  "myrecipesId": 1, 
  "userId": "1"
}

Caso dê tudo certo, a resposta será assim:

{
  "title": "Bolo de Laranja Vegano",
  "ingredients": [
    "1 laranja em cubos",
    "1/2 xícara de suco de laranja",
    "3/4 de xícara de óleo",
    "1 xícara de açúcar",
    "2 xícaras de farinha de trigo",
    "1 colher de sopa de fermento em pó",
    "Pitada de sal"
  ],
  "instructions": [
    "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
    "Misturar em uma tigela a farinha e o fermento em pó.",
    "Incorporar a mistura do liquidificador na farinha com o fermento.",
    "Colocar a massa em uma forma untada e enfarinhada.",
    "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
  ],
  "category": "doce",
  "author": "Mark",
  "favorites_users": [],
  "myrecipesId": 1, 
  "userId": "1",
  "id": 1
}

Ver Receitas Públicas

GET /recipes - FORMATO DA RESPOSTA - STATUS 200

Caso dê tudo certo, a resposta será assim:

[
  {
    "title": "Bolo de Maçã Vegano",
    "ingredients": [
      "1 maçã em cubos",
      "1/2 xícara de suco de laranja",
      "3/4 de xícara de óleo",
      "1 xícara de açúcar",
      "2 xícaras de farinha de trigo",
      "1 colher de sopa de fermento em pó",
      "Pitada de sal"
    ],
    "instructions": [
      "Bater no liquidificador a laranja, o suco, o óleo, o açúcar e o sal e reservar.",
      "Misturar em uma tigela a farinha e o fermento em pó.",
      "Incorporar a mistura do liquidificador na farinha com o fermento.",
      "Colocar a massa em uma forma untada e enfarinhada.",
      "Assar por 40 a 50 minutos em forno pré-aquecido a 180ºC."
    ],
    "category": "doce",
    "author": "Mark",
    "favorites_users": [],
    "myrecipesId": 1, 
    "userId": "1",
    "id": 1
  }
]

api-cookin's People

Contributors

renatosuguiy avatar emilyregolao avatar larissakoliveira avatar raissalst avatar manoelacunha avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.