Esta é a API de um sistema de e-commerce. A API permite o gerenciamento de usuários, produtos, categorias, carrinhos de compras, endereços e pedidos.
- URL:
/register
- Método:
POST
- Descrição: Registra um novo usuário.
- Parâmetros:
name
(string): Nome do usuário.email
(string): Email do usuário.password
(string): Senha do usuário.
- URL:
/login
- Método:
POST
- Descrição: Realiza o login do usuário.
- Parâmetros:
email
(string): Email do usuário.password
(string): Senha do usuário.
- URL:
/logout
- Método:
POST
- Descrição: Realiza o logout do usuário.
- Middleware:
auth:api
- URL:
/user
- Método:
GET
- Descrição: Retorna os dados do usuário autenticado.
- Middleware:
auth:api
- URL:
/produtos
- Método:
GET
- Descrição: Retorna uma lista de todos os produtos.
- URL:
/produtos/{id}
- Método:
GET
- Descrição: Retorna os detalhes de um produto específico.
- URL:
/categorias
- Método:
GET
- Descrição: Retorna uma lista de todas as categorias.
- URL:
/endereco
- Método:
GET
,POST
,PUT
,DELETE
- Descrição: Endpoints para listar, criar, atualizar e deletar endereços.
- Middleware:
auth:api
- URL:
/carrinho/atualiza
- Método:
POST
- Descrição: Adiciona ou atualiza um item no carrinho.
- Parâmetros:
produto_id
(integer): ID do produto.quantidade
(integer): Quantidade do produto.
- Middleware:
auth:api
- URL:
/carrinho
- Método:
GET
- Descrição: Retorna os itens do carrinho do usuário autenticado.
- Middleware:
auth:api
- URL:
/carrinho/remover/{produtoId}
- Método:
DELETE
- Descrição: Remove um item do carrinho.
- Middleware:
auth:api
- URL
/pedido/finalizar
- Método:
POST
- Descrição: Finaliza o pedido a partir dos itens do carrinho.
- Parâmetros:
endereco_id
(integer): ID do endereço de entrega.
- Middleware:
auth:api
- URL: /pedidos
- Método:
GET
- Descrição: Retorna uma lista de pedidos do usuário autenticado.
- Middleware:
auth:api
-
Clone o repositório:
git clone https://github.com/seu-usuario/seu-repositorio.git
-
Instale as dependências:
composer install
-
Configure o arquivo
.env
:cp .env.example .env
-
Gere a chave da aplicação:
php artisan key:generate
-
Configure o banco de dados no arquivo
.env
. -
Execute as migrações:
php artisan migrate
-
Inicie o servidor:
php artisan serve
A API utiliza autenticação via token JWT. Após o login, o token deve ser incluído no cabeçalho das requisições protegidas:
Authorization: Bearer {seu_token}
- Faça um fork do projeto.
- Crie uma branch para sua feature (
git checkout -b feature/nova-feature
). - Commit suas mudanças (
git commit -am 'Adiciona nova feature'
). - Faça o push para a branch (
git push origin feature/nova-feature
). - Crie um novo Pull Request.
Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.