API Conteúdos

Esse projeto é uma API REST para gerenciamento de conteúdos, incluindo posts, vídeos e comentários. Desenvolvida com Laravel 13, a API segue as melhores práticas de desenvolvimento RESTful, garantindo segurança, escalabilidade e facilidade de manutenção. A autenticação é implementada usando Laravel Sanctum, proporcionando uma experiência segura para os usuários. Além disso, a documentação da API é gerada automaticamente com Scramble, facilitando a compreensão e o uso dos endpoints disponíveis.

Tecnologias • Requisitos • Instalação • Como Usar

---

Tecnologias

Tecnologia	Versão
PHP	8.3+
Laravel	13.0
Laravel Sanctum	4.0
MySQL	8.0
Apache	2.4
Docker	Latest
Scramble	0.13.17

---

Requisitos

• Docker 20.0+
• Docker Compose 1.29+

---

Instalação

Passo 1: Clonar Repositório

git clone https://github.com/pedroazevedoc/api-conteudos.git
cd api-conteudos

Passo 2: Copiar Arquivo de Ambiente

cp .env.example .env

Passo 3: Instalar Dependências do Makefile

sudo apt install make

Passo 4: Construir e Iniciar Containers

# Construir images
make build

# Iniciar containers em background
make up

# Verificar status
docker compose ps

Esperado: 3 containers rodando:

• conteudos-api (Laravel API)
• conteudos-db (MySQL)
• conteudos-phpmyadmin (Gerenciador DB)

Passo 5: Instalar Dependências do Laravel com Composer

make install

Passo 6: Gerar Chave da Aplicação

make key

Passo 7: Executar Migrações

make migrate

Passo 8: Executar Seeders

make seed

Isso irá popular o banco com os dados de exemplo.

API rodando em http://localhost:8000

---

Como Usar

Acessar a Documentação da API (Scramble)

http://localhost:8000/docs/api

Acessar o Banco de Dados

PhpMyAdmin está disponível em: http://localhost:8080

• Host: db
• Usuário: user (padrão)
• Senha: password (padrão)

Importar Coleção Postman

Importe a coleção postman_collection.json para testar os endpoints da API.

Acessar a API

Use ferramentas como Postman ou cURL para interagir com os endpoints da API em http://localhost:8000/api.

Usuário de teste para autenticação:

• Email: admin@email.com
• Senha: 123456

---

Parar os Containers

make down

Reiniciar os Containers

make restart

Ver os Logs da Aplicação

make logs

Acessar o Terminal da Aplicação

make bash