Skip to content

rccheruti/mojo-back

Repository files navigation

Mojo API

  • Este projeto feito com o framework Laravel 10.

Instalação

Clone Repositório

git clone https://github.com/rccheruti/mojo-back.git

Instalar as dependências do projeto

composer install

Gerar a key do projeto Laravel

php artisan key:generate

Módulos

Usuários

Cadastrar

  • Utilizando uma requisição POST para enviar um JSON.
/api/v1/registro

Conteúdo do JSON

   {
       "name" : "Nome de usuário",
       "email" : "[email protected]",
       "password" : "123456",
       "password_confirmation" : "123456",
       "admin":true,
       "creator":false
   }
  • Nome do usuário (pode ser nome completo)
  • Email (usar um email valido)
  • Password
  • Confirmar Password
  • Se é Adminstrador
  • Se é Criador

Como não ficou bem claro se deveria ser um só implementei a possibilidade de a pessoa executar as duas tarefas, logicamente administrador tem todo o poder, mas por fim deixei assim. O usuário irá receber em seu email uma mensagem para confirmação do cadastro, somente será possível o login após confirmação.

Ver todos os registros

  • Enviar uma requisição GET para
/api/v1/registro/listar

Alterar registro

  • Enviar uma requisição PATCH com o id que deseja alterar
/api/v1/registro/editar/{id}
Deletar um registro
  • Enviar uma requisição DELETE com o id que deseja excluir
/api/v1/registro/editar/{id}

Login

Para o usuário logar no sistema

  • Utilizando uma requisição POST para enviar um JSON com as informações de login.
/api/v1/login
   {
       "email" : " ",
       "password" : " "        
   }
  • Email cadastrado
  • Password cadastrado

Retornará um JSON, nele haverá um token de acesso para poder executar as demais funções do sistema.


Locais

Mostrar todos locais registrados

  • Utilizando uma requisição GET traz todos locais cadastrados.
/api/v1/local

Criar novo local

  • Utilizando uma requisição POST para enviar um JSON.
/api/v1/local/store
  {
      "local_name":"Nome do local",
      "cep":"99899898",
      "city":"Cidade",
      "street":"Avenida do limoeiro",
      "number":100
   }

Atualizar local

  • Utilizando uma requisição PATCH para enviar um JSON com as informações que deseja atualizar.
/api/v1/local/update/{id}
  {
      "local_name":"Base Canoas",
      "cep":"99899898",
      "city":"Canoas",
      "street":"Rua Caí",
      "number":2000
  }

Deletar local

  • Utilizando uma requisição DELETE com o id que deseja excluir.
/api/v1/local/delete/{id}

Permissões do usuário

Consulta tipo de permissao

  • Enviar uma requisição GET com o id que deseja consultar
  permissao/usuario/{id}/consulta

Atualizar o tipo de permissao

  • Enviar uma requisição PATCH
permissao/usuario/{id}/atualizar
  {
      "admin":false,
      "creator":true
  }

Roger Cheruti
Whatsapp (48) 99171-9504

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •