rnegrelly / projeto-m4-api_rest Goto Github PK

Projeto de conclusão do módulo 4, idealizado pelo BootCamp Resilia, que nos foi proposto, criar uma aplicação desenvolvida em NodeJs, com Express e SQLite, para gerar e administrar a rotas da API, para gerenciamento de um restaurante.

• VScode
• Insomnia ou Postman
• GIT
• GitHub
• NODE.Js
• HEROKU

1. Utilizar o padrão MVC;
2. Utilizar os verbos HTTP seguindo o padrão REST;
3. Implementar todas as operações de CRUD;
4. Utilizar o padrão de projeto (design pattern) DAO para abstração de transações no banco, com Promises;
5. Utilizar o README.md do repositório para documentação;
6. Utilização de async/await para operações no banco (DAO)
7. Ter o código fonte hospedado em um repositório no Github

HEROKU

	https://restaurante-api-m4.herokuapp.com

1. INSTALAR Node JS NA SUA MÁQUINA.

2. CLONAR ESSE REPOSITÓRIO:

    git clone [API REST](https://github.com/rnegrelly/Projeto-M4-API_REST.git)

3. ACESSAR A PASTA CRIADA ATRAVÉS DO CMD USANDO O COMANDO:

     cd Projeto-M4-API_REST

4. INSTALAR DEPENDÊNCIAS:

     npm install

5. INICIANDO O SERVIDOR:

     npm run dev

Modelo de requisição para o metódo POST:

  {
    "nome_colaborador": "Andressa Ricardo de Amorim",
    "cpf_colaborador": "433.199.143-47",
    "endereco_colaborador": "Av. Edgard Romero nº 87, Madureira, Rio de Janeiro - RJ",
    "cargo_colaborador": "Administrador contábil",
    "email_colaborador": "[email protected]",
    "telefone_colaborador": "(21)98416-2188",
    "turno_colaborador": "Noite",
    "salario_colaborador": "R$ 2.165,30",
    "admissao_colaborador": "13/07/2019",
    "demissao_colaborador": "null"
    }

RETORNA -

Modelo de requisição para o método GET

   {
    "nome":"REFINADO"
   }
   

RETORNA -

Modelo de requisição para o metódo POST:

{
    "categoria_cardapio" : "Pizza Salgada",
    "sabor_cardapio" : "Calabresa",
    "ingredientes_cardapio" : "Queijo Mussarela, molho de tomate, linguiça calabresa, cebola e orégano",
    "tamanho_cardapio" : "Brotinho",
    "valor_cardapio" : "R$15,00"
}

RETORNA - mensagem de sucesso {message: "Cadastrado com sucesso!"} ou mensagem de erro {"Verifique o item. Objeto não cadastrado"}.

Modelo de requisição para o metódo PUT:

{
    "categoria_cardapio" : "Pizza Salgada",
    "sabor_cardapio" : "Calabresa",
    "ingredientes_cardapio" : "Queijo Mussarela, molho de tomate, linguiça calabresa, cebola e orégano",
    "tamanho_cardapio" : "Brotinho",
    "valor_cardapio" : "R$15,00"
}

RETORNA - mensagem de sucesso {message: "A Bebida Suco Natural foi atualizada com sucesso!"} ou mensagem de erro {"Verifique o item. Objeto não atualizado"}.

Modelo de requisição para o metódo DELETE:

{
    "categoria_cardapio" : "Pizza Salgada",
    "sabor_cardapio" : "Calabresa",
    "ingredientes_cardapio" : "Queijo Mussarela, molho de tomate, linguiça calabresa, cebola e orégano",
    "tamanho_cardapio" : "Brotinho",
    "valor_cardapio" : "R$15,00"
}

RETORNA - mensagem de sucesso {"message": "Registro com Id deletado com sucesso"} ou mensagem de erro.

1. Validações:

   • O valor correspondente a chave "categoria_cardapio" deve estar contido na lista ['Bebida', 'Pizza Salgada', 'Pizza Doce'];
   • O valor correspondente a chave "sabor_cardapio" deve ser uma string e não pode estar vazia;
   • O valor correspondente a chave "ingredientes_cardapio" deve ser uma string e não pode estar vazia;
   • O valor correspondente a chave "tamanho_cardapio" deve estar contido na lista ['Brotinho', 'Média', 'Grande', 'Família', 'Lata', "1 litro", '2 litros', '400ml',];
   • O valor correspondente a chave "valor_cardapio" deve ser um dado do tipo string que utilize os caracteres da lista '0123456789.,R$', espaços não são permitidos;
   • Case-sensitive.

Modelo de requisição para o metódo POST:

{
    "nome_cliente": "Giorgian Daniel De Arrascaeta Benedetti",
    "cpf_cliente": "55555555565",
    "endereco_cliente": "Av. Borges de Medeiros, 997 - Gávea, Rio de Janeiro - RJ",
    "email_cliente": "[email protected]",
    "telefone_cliente": "21984162188"
}

RETORNA - Cadastra um novo cliente na base de dados.

Modelo de requisição para o metódo PUT:

{
    "nome_cliente": "Giorgian Daniel De Arrascaeta Benedetti",
    "cpf_cliente": "55555555565",
    "endereco_cliente": "Av. Borges de Medeiros, 997 - Gávea, Rio de Janeiro - RJ",
    "email_cliente": "[email protected]",
    "telefone_cliente": "21984162188"
}

RETORNA - Mensagem de sucesso: "Cliente atualizado com sucesso." Mensagem de erro: "Não foi possível atualizar os dados do Cliente."

1. Validações:

   • O valor de "nome_cliete" deve conter ao menos 3 caracteres;
   • O valor de "cpf_cliente" deve conter exatos 11 caracteres;
   • O valor de "endereco_cliente" deve ser uma string e não pode estar vazia;
   • O valor de "email_cliente" deve ser uma estrutura de email válida, com "@", e ".com".
   • O valor de "telefone_cliente" deve conter exatos 11 caracteres;

Números dos id's cadastrados: 4, 6, 7 e 8.

Modelo de requisição para o metódo POST:

{
  	"nome_fornecedor": "Layse Mayanne",
        "cnpj_fornecedor": "44.438.256/0001-38",
        "endereco_fornecedor": "Rua cimento nobre 405",
        "ramo_fornecedor": "Atacadista",
        "email_fornecedor": "[email protected]",
        "telefone_fornecedor": "(83)3364-8575"
}

RETORNA - mensagem de sucesso {message: "Fornecedor cadastrado com sucesso."} ou mensagem de erro {"Não foi possível efetuar o cadastro do fornecedor"}.

Modelo de requisição para o metódo PUT:

   {
        "nome_fornecedor": "Layse Mayanne",
        "cnpj_fornecedor": "44.438.256/0001-38",
        "endereco_fornecedor": "Rua cimento nobre 405",
        "ramo_fornecedor": "Atacadista",
        "email_fornecedor": "[email protected]",
        "telefone_fornecedor": "(83)3364-8575"
    }

RETORNA - mensagem de sucesso {message: "Fornecedor atualizado!"}.

Modelo de requisição para o metódo DELETE:

   {
        "nome_fornecedor": "Layse Mayanne",
        "cnpj_fornecedor": "44.438.256/0001-38",
        "endereco_fornecedor": "Rua cimento nobre 405",
        "ramo_fornecedor": "Atacadista",
        "email_fornecedor": "[email protected]",
        "telefone_fornecedor": "(83)3364-8575"
    }

RETORNA - mensagem de sucesso {"message": "Fornecedor deletado!"} ou mensagem de erro.