Skip to content

tarmaxz/api-customer

Repository files navigation

API de Cadastro de Clientes com Validação de CEP

📌 Descrição do Projeto

Backend (API em Laravel) para cadastro de clientes, com funcionalidades de listagem, criação, edição e exclusão, além de validação automática de endereço via CEP.


🧱 Arquitetura com Docker

Este projeto roda completamente dentro de containers Docker:

  • Laravel (API PHP) roda no container laravel-app
  • MySQL roda no container mysql
  • Ambos os serviços compartilham a mesma rede Docker

🚀 Tecnologias Utilizadas


📡 Rotas da API

  • GET /api/customers – Listar clientes
  • POST /api/customers – Criar cliente
  • GET /api/customers/{id} – Buscar cliente específico
  • PUT /api/customers/{id} – Atualizar cliente
  • DELETE /api/customers/{id} – Deletar cliente (soft delete)

🛠️ Requisitos

  • Docker 20.10+
  • Docker Compose v1.29+ ou Docker Compose V2

⚙️ Instalação

# 1. Clone o repositório
git clone https://github.com/tarmaxz/api-customer.git
cd seurepositorio

# 2. Copie o arquivo .env
cp .env.example .env

# 3. Suba os containers Laravel e MySQL
docker-compose up --build -d

# 4. Instale as dependências do Laravel dentro do container
docker exec -it laravel-app composer install

# 5. Gere a chave da aplicação
docker exec -it laravel-app php artisan key:generate

# 6. Configure o .env se necessário:
# Variáveis de conexão com o banco dentro do Docker:
DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=api_customer
DB_USERNAME=admin
DB_PASSWORD=admin

# 7. Rode as migrations e seeders
docker exec -it laravel-app php artisan migrate --seed

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages