API-ACADEMIA

Conteúdo

• Sobre a Aplicação
• Tecnologias
• Iniciando a Aplicação
• Licença
• Contato

Sobre a aplicação

API desenvolvida em Adonis.js que implementa um CRUD com banco de dados MySQL.
Permite a inclusão de usuários, clientes, exercícios, treinos e produtos, além de alteração, exclusão e consulta.
Possui autenticação JWT, upload de imagens, geração de Log, controle de permissões (Roles e Permissions) e middlewares.
Desenvolvido durante o curso Criando uma REST API com adonis.js: do básico ao avançado, do prof. Augusto Gehrke.

Rotas da aplicação

Método	Caminho da Rota	Descrição
POST	/sessions	Geração do Token
PUT	/sessions	Refresh Token
GET	/users	Lista de usuários
GET	/users/:id	Dados do usuário
POST	/users	Inclusão de usuário
PUT	/users/:id	Alteração do usuário
DELETE	/users/:id	Exclusão do usuário
GET	/clients	Lista de clientes
GET	/clients/:id	Dados do cliente
POST	/clients	Inclusão de cliente
PUT	/clients/:id	Alteração do cliente
DELETE	/clients/:id	Exclusão do cliente
GET	/exercises	Lista de exercícios
GET	/exercises/:id	Dados do exercício
POST	/exercises	Inclusão de exercício
PUT	/exercises/:id	Alteração do exercício
DELETE	/exercises/:id	Exclusão do exercício
GET	/trainings	Lista de treinamentos
GET	/trainings/:id	Dados do treinamento
POST	/trainings	Inclusão de treinamento
PUT	/trainings/:id	Alteração do treinamento
DELETE	/trainings/:id	Exclusão do treinamento
GET	/products	Lista de produtos
POST	/products	Inclusão de produto (imagem)
GET	/permissions	Lista de permissões
GET	/permissions/:id	Dados da permissão
POST	/permissions	Inclusão de permissão
PUT	/permissions/:id	Alteração da permissão
DELETE	/permissions/:id	Exclusão da permissão
GET	/roles	Lista de papéis
GET	/roles/:id	Dados do papel
POST	/roles	Inclusão de papel
PUT	/roles/:id	Alteração do papel
DELETE	/roles/:id	Exclusão do papel

🛠️ Tecnologias

• AdonisJS
• MySQL

🚗 Iniciando a aplicação

# Baixe o repositório com git clone e entre na pasta do projeto.
$ git clone https://github.com/luiizsilverio/api-academia.git

# Execute yarn para instalar as dependências (ou npm install)
$ yarn

# Renomeie o arquivo .env.example para .env
# informe a APP_KEY. Caso não tenha, gere uma chave com o comando:
adonis key:generate

# Para iniciar a aplicação
$ yarn dev

# Abra http://localhost:3333 no navegador

⚖️ Licença

Este projeto está licenciado sob a licença MIT.

📧 Contato

E-mail: luiiz.silverio@gmail.com