Compare commits

...

6 Commits

70 changed files with 13088 additions and 2 deletions

18
.editorconfig Normal file
View File

@@ -0,0 +1,18 @@
root = true
[*]
charset = utf-8
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
[*.{yml,yaml}]
indent_size = 2
[compose.yaml]
indent_size = 4

65
.env.example Normal file
View File

@@ -0,0 +1,65 @@
APP_NAME=Laravel
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
APP_LOCALE=en
APP_FALLBACK_LOCALE=en
APP_FAKER_LOCALE=en_US
APP_MAINTENANCE_DRIVER=file
# APP_MAINTENANCE_STORE=database
# PHP_CLI_SERVER_WORKERS=4
BCRYPT_ROUNDS=12
LOG_CHANNEL=stack
LOG_STACK=single
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug
DB_CONNECTION=sqlite
# DB_HOST=127.0.0.1
# DB_PORT=3306
# DB_DATABASE=laravel
# DB_USERNAME=root
# DB_PASSWORD=
SESSION_DRIVER=database
SESSION_LIFETIME=120
SESSION_ENCRYPT=false
SESSION_PATH=/
SESSION_DOMAIN=null
BROADCAST_CONNECTION=log
FILESYSTEM_DISK=local
QUEUE_CONNECTION=database
CACHE_STORE=database
# CACHE_PREFIX=
MEMCACHED_HOST=127.0.0.1
REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
MAIL_MAILER=log
MAIL_SCHEME=null
MAIL_HOST=127.0.0.1
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false
VITE_APP_NAME="${APP_NAME}"

11
.gitattributes vendored Normal file
View File

@@ -0,0 +1,11 @@
* text=auto eol=lf
*.blade.php diff=html
*.css diff=css
*.html diff=html
*.md diff=markdown
*.php diff=php
/.github export-ignore
CHANGELOG.md export-ignore
.styleci.yml export-ignore

24
.gitignore vendored Normal file
View File

@@ -0,0 +1,24 @@
*.log
.DS_Store
.env
.env.backup
.env.production
.phpactor.json
.phpunit.result.cache
/.fleet
/.idea
/.nova
/.phpunit.cache
/.vscode
/.zed
/auth.json
/node_modules
/public/build
/public/hot
/public/storage
/storage/*.key
/storage/pail
/vendor
Homestead.json
Homestead.yaml
Thumbs.db

621
BLOG-API.md Normal file
View File

@@ -0,0 +1,621 @@
# BLOG-API — Microserviço de Blog/Notícias
> **Status:** projeto funcional e testado localmente com Laravel 12, API versionada em `/api/v1`, conexão com banco validada, CRUD de categorias validado e CRUD/listagem/filtros de posts validados.
## Integrantes
| Nome | Função no projeto |
| **João Carlos Campos** | Desenvolvimento da API e documentação Modelagem,banco de dados e revisão. |
| **Lucas Higinio** | Testes, validação das rotas e integração. |
## Descrição do serviço
O **BLOG-API** é um microserviço responsável pelo gerenciamento e disponibilização de conteúdos de **blog, notícias e comunicados** dentro de uma arquitetura baseada em múltiplos serviços. Ele oferece uma API REST para criação, consulta, atualização e exclusão de **posts** e **categorias**, além de fornecer endpoints públicos para listagem paginada, busca por título, filtros por categoria, filtros por posts em destaque e consulta por slug.
O serviço foi desenvolvido com **Laravel 12** e segue uma organização orientada a boas práticas, utilizando **Models**, **Migrations**, **Controllers**, **Form Requests**, **API Resources**, rotas versionadas e health checks. A API foi preparada para futuramente receber autenticação JWT no grupo administrativo, mantendo separadas as rotas públicas de leitura e as rotas administrativas de escrita.
## Responsabilidades do microsserviço
| Responsabilidade | Descrição |
|---|---|
| Gerenciar categorias | Permite criar, listar, visualizar, atualizar e excluir categorias de notícias. |
| Gerenciar posts | Permite criar, listar, visualizar, atualizar e excluir posts do blog/notícias. |
| Gerar slugs automáticos | Cria slugs únicos a partir do título do post ou nome da categoria. |
| Controlar publicação | Permite definir posts como `draft` ou `published`, além de informar `published_at`. |
| Destacar conteúdos | Permite marcar posts como destaque por meio do campo `is_featured`. |
| Fornecer listagem pública | Disponibiliza posts e categorias para consumo por frontend, gateway ou outros serviços. |
| Aplicar filtros | Permite busca por título, filtro por categoria, filtro por destaque e paginação. |
| Validar dados recebidos | Usa Form Requests para garantir entrada consistente e retornos de erro padronizados. |
| Padronizar respostas | Usa API Resources para retornar JSON organizado e previsível. |
| Verificar saúde do serviço | Oferece rotas de health check do serviço e da conexão com banco. |
## Tecnologias utilizadas
| Tecnologia | Finalidade |
|---|---|
| **PHP 8.2+** | Linguagem utilizada para executar a aplicação Laravel. |
| **Laravel 12** | Framework principal da API. |
| **Composer** | Gerenciador de dependências PHP. |
| **MySQL/MariaDB** | Banco de dados utilizado no ambiente local com XAMPP. |
| **XAMPP** | Ambiente local contendo Apache, PHP e MySQL/MariaDB. |
| **PowerShell** | Terminal usado nos testes locais em Windows. |
| **Git e GitHub** | Versionamento e hospedagem do repositório. |
## Requisitos necessários para rodar o projeto
Este projeto foi testado localmente sem Docker, utilizando XAMPP no Windows. Para executar o projeto, é necessário ter PHP, Composer, MySQL/MariaDB e Git instalados e acessíveis pelo terminal.
| Requisito | Versão recomendada |
|---|---|
| PHP | 8.2 ou superior |
| Composer | 2.x ou superior |
| Laravel | 12.x |
| Banco de dados | MySQL 8.x ou MariaDB compatível |
| Servidor local | XAMPP ou equivalente |
| Git | Versão atual estável |
## Opção escolhida: sem Docker
Nesta entrega, o projeto está configurado para execução **sem Docker**, usando ambiente local com XAMPP. Portanto, os arquivos `Dockerfile` e `docker-compose.yml` não são obrigatórios para esta versão. Caso o grupo decida migrar para Docker futuramente, será necessário adicionar esses arquivos e atualizar este README com portas, containers, volumes e variáveis de ambiente.
## Passo a passo de instalação
Clone o repositório e acesse a pasta do projeto:
```bash
git clone https://github.com/SEU-USUARIO/BLOG-API.git
cd BLOG-API
```
Instale as dependências PHP:
```bash
composer install
```
Crie o arquivo de ambiente com base no exemplo:
```bash
cp .env.example .env
```
No Windows PowerShell, caso o comando `cp` não esteja disponível, use:
```powershell
copy .env.example .env
```
Gere a chave da aplicação:
```bash
php artisan key:generate
```
Crie o banco de dados no MySQL/MariaDB com o nome:
```sql
CREATE DATABASE blog_api;
```
Depois execute as migrations:
```bash
php artisan migrate
```
## Configuração do `.env`
A configuração abaixo representa o ambiente local usando MySQL/MariaDB pelo XAMPP. O usuário padrão costuma ser `root` e, em instalações locais comuns do XAMPP, a senha geralmente fica vazia.
```dotenv
APP_NAME="Blog API"
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://127.0.0.1:8000
APP_LOCALE=pt_BR
APP_FALLBACK_LOCALE=pt_BR
APP_FAKER_LOCALE=pt_BR
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=blog_api
DB_USERNAME=root
DB_PASSWORD=
CACHE_STORE=file
SESSION_DRIVER=file
QUEUE_CONNECTION=sync
LOG_CHANNEL=stack
LOG_LEVEL=debug
```
Após alterar o `.env`, limpe as configurações carregadas em cache:
```bash
php artisan config:clear
php artisan route:clear
```
## Registro das rotas de API no Laravel 12
Em projetos Laravel 12 recém-criados, é importante confirmar que o arquivo `routes/api.php` está registrado no `bootstrap/app.php`. O bloco `withRouting` deve conter a entrada `api`:
```php
->withRouting(
web: __DIR__.'/../routes/web.php',
api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
```
Sem essa configuração, as rotas `/api/v1/...` podem retornar `404 Not Found`, mesmo que o arquivo `routes/api.php` exista no projeto.
## Como executar o projeto
Com o banco de dados criado, dependências instaladas e `.env` configurado, execute:
```bash
php artisan serve
```
A aplicação ficará disponível em:
```text
http://127.0.0.1:8000
```
O dashboard simples com as rotas documentadas pode ser acessado em:
```text
http://127.0.0.1:8000/
```
## Como testar o projeto
Primeiro, teste se o serviço está online:
```bash
curl http://127.0.0.1:8000/api/v1/health
```
Depois, teste a conexão com o banco:
```bash
curl http://127.0.0.1:8000/api/v1/health-check-db
```
No PowerShell, recomenda-se usar `Invoke-RestMethod` para testar requisições JSON com mais segurança.
```powershell
Invoke-RestMethod -Uri "http://127.0.0.1:8000/api/v1/health" -Method Get
```
## Rotas da API
As rotas seguem o prefixo `/api/v1`. As rotas públicas são usadas para leitura e podem ser consumidas por frontend, gateway ou outros microsserviços. As rotas administrativas permitem escrita e estão preparadas para receber autenticação JWT futuramente.
| Método | Endpoint | Acesso | Descrição |
|---|---|---|---|
| `GET` | `/api/v1/health` | Público | Verifica se o serviço está online. |
| `GET` | `/api/v1/health-check-db` | Público | Verifica se a conexão com o banco de dados está funcionando. |
| `GET` | `/api/v1/public/posts` | Público | Lista posts com paginação e filtros. |
| `GET` | `/api/v1/public/posts/{slug}` | Público | Busca um post publicado pelo slug. |
| `GET` | `/api/v1/public/categories` | Público | Lista categorias com contagem de posts. |
| `GET` | `/api/v1/public/categories/{slug}` | Público | Busca uma categoria pelo slug. |
| `GET` | `/api/v1/admin/posts` | Administrativo | Lista posts no contexto administrativo. |
| `POST` | `/api/v1/admin/posts` | Administrativo | Cria um novo post. |
| `GET` | `/api/v1/admin/posts/{id}` | Administrativo | Busca um post por ID. |
| `PUT/PATCH` | `/api/v1/admin/posts/{id}` | Administrativo | Atualiza um post existente. |
| `DELETE` | `/api/v1/admin/posts/{id}` | Administrativo | Remove um post. |
| `GET` | `/api/v1/admin/categories` | Administrativo | Lista categorias. |
| `POST` | `/api/v1/admin/categories` | Administrativo | Cria uma nova categoria. |
| `GET` | `/api/v1/admin/categories/{id}` | Administrativo | Busca uma categoria por ID. |
| `PUT/PATCH` | `/api/v1/admin/categories/{id}` | Administrativo | Atualiza uma categoria existente. |
| `DELETE` | `/api/v1/admin/categories/{id}` | Administrativo | Remove uma categoria, desde que não tenha posts vinculados. |
## Filtros disponíveis na listagem de posts
| Parâmetro | Tipo | Exemplo | Descrição |
|---|---|---|---|
| `search` | string | `/api/v1/public/posts?search=Laravel` | Busca posts pelo título. |
| `category_id` | integer | `/api/v1/public/posts?category_id=1` | Filtra posts por ID da categoria. |
| `category_slug` | string | `/api/v1/public/posts?category_slug=tecnologia` | Filtra posts pelo slug da categoria. |
| `is_featured` | boolean | `/api/v1/public/posts?is_featured=true` | Filtra posts destacados. |
| `status` | string | `/api/v1/public/posts?status=published` | Filtra por `draft` ou `published`. |
| `per_page` | integer | `/api/v1/public/posts?per_page=15` | Define a quantidade de itens por página. |
## Exemplos de requisição e resposta em JSON
### Criar categoria
**Requisição:**
```http
POST /api/v1/admin/categories
Content-Type: application/json
Accept: application/json
```
```json
{
"name": "Tecnologia",
"description": "Noticias sobre tecnologia, inovacao e software."
}
```
**Resposta esperada:**
```json
{
"data": {
"id": 1,
"name": "Tecnologia",
"slug": "tecnologia",
"description": "Noticias sobre tecnologia, inovacao e software.",
"posts_count": 0,
"created_at": "2026-05-28T16:17:19.000000Z",
"updated_at": "2026-05-28T16:17:19.000000Z"
}
}
```
### Criar post
**Requisição:**
```http
POST /api/v1/admin/posts
Content-Type: application/json
Accept: application/json
```
```json
{
"title": "Laravel 12 em Microsservicos",
"content": "Conteudo completo da noticia sobre Laravel 12 em uma arquitetura de microsservicos.",
"excerpt": "Resumo da noticia sobre Laravel 12.",
"category_id": 1,
"featured_image": "https://cdn.example.com/images/laravel.jpg",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28 10:00:00"
}
```
**Resposta esperada:**
```json
{
"data": {
"id": 1,
"title": "Laravel 12 em Microsservicos",
"slug": "laravel-12-em-microsservicos",
"content": "Conteudo completo da noticia sobre Laravel 12 em uma arquitetura de microsservicos.",
"excerpt": "Resumo da noticia sobre Laravel 12.",
"featured_image": "https://cdn.example.com/images/laravel.jpg",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28T10:00:00.000000Z",
"category": {
"id": 1,
"name": "Tecnologia",
"slug": "tecnologia",
"description": "Noticias sobre tecnologia, inovacao e software."
},
"created_at": "2026-05-28T16:18:43.000000Z",
"updated_at": "2026-05-28T16:18:43.000000Z"
}
}
```
### Listar posts com paginação
**Requisição:**
```http
GET /api/v1/public/posts
Accept: application/json
```
**Resposta esperada:**
```json
{
"data": [
{
"id": 1,
"title": "Laravel 12 em Microsservicos",
"slug": "laravel-12-em-microsservicos",
"excerpt": "Resumo da noticia sobre Laravel 12.",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28T10:00:00.000000Z",
"category": {
"id": 1,
"name": "Tecnologia",
"slug": "tecnologia"
}
}
],
"links": {
"first": "http://127.0.0.1:8000/api/v1/public/posts?page=1",
"last": "http://127.0.0.1:8000/api/v1/public/posts?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"per_page": 15,
"total": 1
}
}
```
### Atualizar post
**Requisição:**
```http
PATCH /api/v1/admin/posts/1
Content-Type: application/json
Accept: application/json
```
```json
{
"title": "Laravel 12 em APIs de Noticias",
"is_featured": false
}
```
**Resposta esperada:**
```json
{
"data": {
"id": 1,
"title": "Laravel 12 em APIs de Noticias",
"slug": "laravel-12-em-apis-de-noticias",
"is_featured": false,
"status": "published"
}
}
```
### Excluir post
**Requisição:**
```http
DELETE /api/v1/admin/posts/1
Accept: application/json
```
**Resposta esperada:**
```json
{
"message": "Post deleted successfully."
}
```
## Quais dados o serviço recebe
O serviço recebe dados relacionados a categorias e posts. Para categorias, recebe `name`, `slug` opcional e `description`. Para posts, recebe `title`, `slug` opcional, `content`, `excerpt`, `category_id`, `featured_image`, `is_featured`, `status` e `published_at`.
| Entidade | Dados recebidos |
|---|---|
| Categoria | `name`, `slug`, `description` |
| Post | `title`, `slug`, `content`, `excerpt`, `category_id`, `featured_image`, `is_featured`, `status`, `published_at` |
## Quais dados o serviço retorna
O serviço retorna respostas JSON padronizadas por meio de API Resources. As respostas de post incluem os dados principais do conteúdo e, quando aplicável, os dados da categoria relacionada. As listagens paginadas retornam também os objetos `links` e `meta`, permitindo navegação entre páginas.
| Resposta | Dados retornados |
|---|---|
| Categoria | `id`, `name`, `slug`, `description`, `posts_count`, `created_at`, `updated_at` |
| Post | `id`, `title`, `slug`, `content`, `excerpt`, `featured_image`, `is_featured`, `status`, `published_at`, `category`, `created_at`, `updated_at` |
| Paginação | `data`, `links`, `meta` |
## Integrações com outros microsserviços
O **BLOG-API** foi pensado para participar de uma arquitetura maior de microsserviços. Nesta versão, a integração real implementada é com o banco de dados do próprio serviço. As demais integrações estão documentadas como pontos previstos para evolução do sistema.
| Serviço externo | Tipo de integração | Situação | Descrição |
|---|---|---|---|
| Auth Service | Consumo futuro | Preparado | O grupo administrativo poderá validar JWT emitido pelo serviço de autenticação. |
| Gateway/API Gateway | Consumidor da API | Previsto | Um gateway pode encaminhar chamadas públicas e administrativas para o BLOG-API. |
| Frontend/Web App | Consumidor da API | Previsto | A interface web/mobile pode consumir posts, categorias, destaques e buscas. |
| Notification Service | Consumidor/evento futuro | Previsto | Pode ser notificado quando um post for publicado para avisar usuários. |
| Media/Storage Service | Consumo futuro | Previsto | Pode armazenar e fornecer URLs de imagens usadas em `featured_image`. |
| Search Service | Consumidor futuro | Previsto | Pode indexar posts publicados para busca global do sistema. |
## Quais serviços o BLOG-API consome
Atualmente, o BLOG-API consome diretamente apenas seu banco de dados relacional. Em uma evolução da arquitetura, ele poderá consumir o serviço de autenticação para validar permissões administrativas e um serviço de mídia para gerenciar upload e armazenamento de imagens.
| Serviço consumido | Finalidade |
|---|---|
| Banco MySQL/MariaDB | Persistir posts, categorias e metadados. |
| Auth Service | Validar tokens JWT em rotas administrativas, em evolução futura. |
| Media/Storage Service | Obter ou validar URLs de imagens destacadas, em evolução futura. |
## Quais serviços utilizam a API
A API pode ser utilizada por interfaces frontend, aplicativos móveis, gateway central, microsserviço de notificações, serviço de busca e painéis administrativos.
| Consumidor | Uso principal |
|---|---|
| Frontend Web | Exibir notícias, posts, categorias e destaques. |
| Aplicativo Mobile | Consumir conteúdo público do blog/notícias. |
| API Gateway | Centralizar o acesso ao microserviço. |
| Painel Administrativo | Criar, editar e remover posts e categorias. |
| Notification Service | Enviar notificações quando novos posts forem publicados. |
| Search Service | Indexar conteúdos publicados para busca global. |
## Fluxo principal do serviço
O fluxo principal começa quando um administrador cria uma categoria e, em seguida, cadastra um post vinculado a essa categoria. O serviço valida os dados recebidos, gera automaticamente o slug, grava as informações no banco de dados e disponibiliza o conteúdo pelas rotas públicas quando o status está como `published`.
| Etapa | Descrição |
|---|---|
| 1 | Administrador cria uma categoria, como `Tecnologia`. |
| 2 | Administrador cria um post vinculado à categoria. |
| 3 | O BLOG-API valida os dados usando Form Requests. |
| 4 | O serviço gera slugs únicos para categoria e post. |
| 5 | O post é salvo como `draft` ou `published`. |
| 6 | Se publicado, o post fica disponível nas rotas públicas. |
| 7 | Frontend, gateway ou outros serviços consomem a listagem de posts. |
| 8 | Serviços externos, como notificações ou busca, podem utilizar os dados publicados. |
### Exemplo de fluxo dentro do sistema geral
```text
Administrador cadastra categoria
Administrador publica notícia
BLOG-API valida, gera slug e salva no banco
Frontend/Gateway consulta /api/v1/public/posts
Usuário visualiza notícia publicada
Serviços de busca/notificação podem consumir o conteúdo publicado
```
## Possíveis erros e retornos esperados
A API retorna códigos HTTP adequados para falhas de validação, registros inexistentes, conflitos de integridade e indisponibilidade do banco.
| Situação | Código HTTP | Exemplo de retorno |
|---|---:|---|
| Dados inválidos | `422` | Campos obrigatórios ausentes ou formato inválido. |
| Post inexistente | `404` | Registro não encontrado. |
| Categoria inexistente | `404` | Registro não encontrado. |
| Categoria com posts vinculados | `409` | Exclusão bloqueada por conflito de integridade. |
| Serviço indisponível | `500` | Erro inesperado do servidor. |
| Banco indisponível | `503` | Health check do banco falha. |
### Exemplo de erro de validação
```json
{
"message": "The title field is required.",
"errors": {
"title": [
"The title field is required."
]
}
}
```
### Exemplo de categoria inexistente
```json
{
"message": "No query results for model [App\\Models\\Category] 999"
}
```
### Exemplo de conflito ao excluir categoria com posts
```json
{
"message": "Category cannot be deleted because it has posts associated."
}
```
## Comandos úteis para testes no PowerShell
### Criar categoria
```powershell
$body = @{
name = "Tecnologia"
description = "Noticias sobre tecnologia, inovacao e software."
} | ConvertTo-Json -Compress
Invoke-RestMethod `
-Uri "http://127.0.0.1:8000/api/v1/admin/categories" `
-Method Post `
-Headers @{ Accept = "application/json" } `
-ContentType "application/json" `
-Body $body
```
### Criar post
```powershell
$body = @{
title = "Laravel 12 em Microsservicos"
content = "Conteudo completo da noticia sobre Laravel 12 em uma arquitetura de microsservicos."
excerpt = "Resumo da noticia sobre Laravel 12."
category_id = 1
featured_image = "https://cdn.example.com/images/laravel.jpg"
is_featured = $true
status = "published"
published_at = "2026-05-28 10:00:00"
} | ConvertTo-Json -Compress
Invoke-RestMethod `
-Uri "http://127.0.0.1:8000/api/v1/admin/posts" `
-Method Post `
-Headers @{ Accept = "application/json" } `
-ContentType "application/json" `
-Body $body
```
### Listar posts formatando JSON
```powershell
$response = Invoke-RestMethod -Uri "http://127.0.0.1:8000/api/v1/public/posts" -Method Get
$response | ConvertTo-Json -Depth 10
```
## Documentação dos arquivos principais
| Arquivo | Responsabilidade |
|---|---|
| `app/Models/Post.php` | Model de posts com relacionamento, casts e slug automático. |
| `app/Models/Category.php` | Model de categorias com relacionamento e slug automático. |
| `app/Http/Controllers/Api/PostController.php` | CRUD, filtros, paginação e respostas de posts. |
| `app/Http/Controllers/Api/CategoryController.php` | CRUD e validações de integridade das categorias. |
| `app/Http/Requests/PostRequest.php` | Validação dos dados de posts. |
| `app/Http/Requests/CategoryRequest.php` | Validação dos dados de categorias. |
| `app/Http/Resources/PostResource.php` | Padronização do JSON de posts. |
| `app/Http/Resources/CategoryResource.php` | Padronização do JSON de categorias. |
| `database/migrations/*create_categories_table.php` | Estrutura da tabela `categories`. |
| `database/migrations/*create_posts_table.php` | Estrutura da tabela `posts`. |
| `routes/api.php` | Rotas versionadas da API. |
| `routes/web.php` | Dashboard simples com rotas disponíveis. |
## Checklist de entrega
| Item obrigatório | Situação |
|---|---|
| Link do repositório | Pendente após criação no GitHub. |
| README completo | Atendido por este arquivo. |
| `.env.example` | Deve ser versionado no repositório. |
| Dockerfile e docker-compose.yml | Não aplicável nesta entrega, pois a opção escolhida é sem Docker. |
| Documentação das rotas | Atendida. |
| Exemplos JSON | Atendidos. |
| Explicação das integrações | Atendida. |
| Fluxo principal do serviço | Atendido. |
| Como executar localmente | Atendido. |
| Como testar localmente | Atendido. |
## Referências
[1]: https://laravel.com/docs/12.x "Laravel 12 Documentation"
[2]: https://getcomposer.org/doc/ "Composer Documentation"
[3]: https://www.php.net/manual/pt_BR/ "PHP Manual"

548
README.md
View File

@@ -1,3 +1,547 @@
# blog-api
# 📰 BLOG-API — Microserviço de Blog/Notícias
Microserviço de Blog/Notícias em Laravel 12 com API REST, posts, categorias, filtros, paginação e health checks.
![PHP](https://img.shields.io/badge/PHP-8.2%2B-777BB4?style=flat-square&logo=php&logoColor=white)
![Laravel](https://img.shields.io/badge/Laravel-12.x-FF2D20?style=flat-square&logo=laravel&logoColor=white)
![MySQL](https://img.shields.io/badge/MySQL%2FMariaDB-Banco%20de%20Dados-4479A1?style=flat-square&logo=mysql&logoColor=white)
![Status](https://img.shields.io/badge/Status-Funcional-brightgreen?style=flat-square)
Este é o microserviço responsável pelo gerenciamento de **posts**, **categorias**, **notícias publicadas**, **conteúdos em destaque** e **listagens públicas filtradas** dentro de um ecossistema baseado em APIs. O serviço permite cadastrar, consultar, atualizar e remover conteúdos de blog/notícias, além de disponibilizar endpoints públicos para consumo por frontend, gateway ou outros microsserviços.
---
## 👥 Integrantes do Grupo
- **João Carlos Campos**
- **Lucas Higinio**
---
## 📝 Descrição do Serviço
O **BLOG-API** atua como o serviço central de publicação de conteúdos informativos em uma arquitetura de microsserviços. Ele resolve o problema de organização e distribuição de notícias, permitindo que administradores cadastrem categorias e posts, enquanto usuários e outros serviços consomem apenas os conteúdos públicos publicados.
A API foi desenvolvida em **Laravel 12**, utilizando uma estrutura organizada com **Models**, **Migrations**, **Controllers**, **Form Requests**, **API Resources** e rotas versionadas em `/api/v1`. O projeto está preparado para evoluir com autenticação JWT nas rotas administrativas, mantendo separadas as operações públicas de leitura e as operações administrativas de escrita.
---
## ⚙️ Responsabilidades do Microsserviço
- **Gerenciamento de Categorias:** cadastrar, listar, consultar, atualizar e excluir categorias de notícias.
- **Gerenciamento de Posts:** cadastrar, listar, consultar, atualizar e excluir posts do blog/notícias.
- **Geração de Slugs:** criar slugs automaticamente a partir do nome da categoria ou título do post.
- **Controle de Publicação:** permitir que posts sejam definidos como `draft` ou `published`.
- **Posts em Destaque:** permitir marcação de conteúdos especiais por meio do campo `is_featured`.
- **Listagem Pública:** disponibilizar posts e categorias para consumo externo.
- **Filtros e Paginação:** permitir busca por título, categoria, destaque, status e paginação.
- **Validação de Dados:** validar entradas por meio de Form Requests.
- **Padronização de Respostas:** retornar dados em JSON utilizando API Resources.
- **Health Checks:** fornecer rotas para verificar a saúde da API e da conexão com o banco.
---
## 🛠️ Tecnologias Utilizadas
| Tecnologia | Uso no Projeto |
|---|---|
| **PHP 8.2+** | Linguagem principal utilizada pela aplicação. |
| **Laravel 12** | Framework utilizado para construção da API REST. |
| **Composer** | Gerenciador de dependências PHP. |
| **MySQL/MariaDB** | Banco de dados relacional utilizado pelo microserviço. |
| **XAMPP** | Ambiente local usado para executar Apache, PHP e MySQL/MariaDB no Windows. |
| **PowerShell** | Terminal utilizado para execução dos comandos e testes locais. |
| **Git** | Controle de versão do código-fonte. |
| **GitHub/Git remoto** | Hospedagem do repositório e entrega do projeto. |
---
## ⚙️ Requisitos Necessários
Para rodar este microserviço localmente, é necessário ter instalado:
- **PHP 8.2 ou superior**.
- **Composer 2.x ou superior**.
- **MySQL ou MariaDB**, podendo ser pelo XAMPP.
- **Git** para clonar e versionar o projeto.
- **PowerShell**, Prompt de Comando, Git Bash ou terminal equivalente.
| Requisito | Versão Recomendada |
|---|---|
| PHP | 8.2+ |
| Laravel | 12.x |
| Composer | 2.x+ |
| Banco de dados | MySQL 8.x ou MariaDB compatível |
| Servidor local | XAMPP ou equivalente |
---
## 📦 Ambiente de Execução
Este projeto foi configurado para execução **sem Docker**, utilizando ambiente local com **XAMPP** no Windows. Portanto, os arquivos `Dockerfile` e `docker-compose.yml` não são obrigatórios nesta entrega.
> A opção escolhida para esta entrega foi a execução local sem Docker. Caso o projeto seja migrado futuramente para containers, será necessário criar o `Dockerfile`, o `docker-compose.yml` e atualizar esta documentação com portas, serviços, volumes e variáveis de ambiente.
---
## 🚀 Passo a Passo de Instalação e Execução
### 1. Clonar o Repositório
```bash
git clone https://github.com/JCUNME12/BLOG-API.git
cd BLOG-API
```
Caso esteja usando o repositório institucional, utilize:
```bash
git clone https://git.juancjc.com.br/Joao_Carlos_Campos/blog-api.git
cd blog-api
```
### 2. Instalar as Dependências
```bash
composer install
```
### 3. Criar o Arquivo `.env`
No Windows PowerShell, execute:
```powershell
copy .env.example .env
```
Em Linux, macOS ou Git Bash, execute:
```bash
cp .env.example .env
```
### 4. Gerar a Chave da Aplicação
```bash
php artisan key:generate
```
### 5. Criar o Banco de Dados
No MySQL/MariaDB, crie um banco chamado `blog_api`:
```sql
CREATE DATABASE blog_api;
```
### 6. Executar as Migrations
```bash
php artisan migrate
```
### 7. Iniciar o Servidor Local
```bash
php artisan serve
```
A aplicação ficará disponível em:
```text
http://127.0.0.1:8000
```
---
## 🔐 Configuração do `.env`
O arquivo `.env.example` deve ficar versionado no repositório. Já o arquivo `.env` real deve permanecer apenas na máquina local, pois contém configurações específicas do ambiente.
```dotenv
APP_NAME="Blog API"
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://127.0.0.1:8000
APP_LOCALE=pt_BR
APP_FALLBACK_LOCALE=pt_BR
APP_FAKER_LOCALE=pt_BR
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=blog_api
DB_USERNAME=root
DB_PASSWORD=
CACHE_STORE=file
SESSION_DRIVER=file
QUEUE_CONNECTION=sync
LOG_CHANNEL=stack
LOG_LEVEL=debug
```
Após alterar configurações de ambiente, limpe o cache do Laravel:
```bash
php artisan config:clear
php artisan route:clear
```
---
## 🧭 Observação Importante sobre Laravel 12
Em projetos Laravel 12, o arquivo `routes/api.php` precisa estar registrado no `bootstrap/app.php`. O bloco `withRouting` deve conter a entrada `api`:
```php
->withRouting(
web: __DIR__.'/../routes/web.php',
api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
```
Sem essa configuração, as rotas `/api/v1/...` podem retornar `404 Not Found`, mesmo que estejam corretamente declaradas no arquivo `routes/api.php`.
---
## 🧪 Como Testar o Projeto
Para testar as rotas da API, podem ser usadas ferramentas como **Postman**, **Insomnia** ou o próprio terminal com **Invoke-RestMethod** no PowerShell.
### Teste de Saúde da API
```powershell
Invoke-RestMethod -Uri "http://127.0.0.1:8000/api/v1/health" -Method Get
```
### Teste de Conexão com o Banco
```powershell
Invoke-RestMethod -Uri "http://127.0.0.1:8000/api/v1/health-check-db" -Method Get
```
### Cabeçalhos Recomendados para POST, PUT e PATCH
```http
Accept: application/json
Content-Type: application/json
```
---
## 🔒 Rotas da API
Todas as rotas principais usam o prefixo `/api/v1`. As rotas públicas são voltadas para leitura, enquanto as rotas administrativas realizam operações de criação, atualização e exclusão.
| Método | Endpoint | Tipo | Descrição |
|---|---|---|---|
| `GET` | `/api/v1/health` | Público | Verifica se a API está online. |
| `GET` | `/api/v1/health-check-db` | Público | Verifica a conexão com o banco de dados. |
| `GET` | `/api/v1/public/posts` | Público | Lista posts publicados com filtros e paginação. |
| `GET` | `/api/v1/public/posts/{slug}` | Público | Busca um post publicado pelo slug. |
| `GET` | `/api/v1/public/categories` | Público | Lista categorias disponíveis. |
| `GET` | `/api/v1/public/categories/{slug}` | Público | Busca uma categoria pelo slug. |
| `GET` | `/api/v1/admin/posts` | Administrativo | Lista posts no contexto administrativo. |
| `POST` | `/api/v1/admin/posts` | Administrativo | Cria um novo post. |
| `GET` | `/api/v1/admin/posts/{id}` | Administrativo | Busca um post por ID. |
| `PUT/PATCH` | `/api/v1/admin/posts/{id}` | Administrativo | Atualiza um post existente. |
| `DELETE` | `/api/v1/admin/posts/{id}` | Administrativo | Remove um post. |
| `GET` | `/api/v1/admin/categories` | Administrativo | Lista categorias no contexto administrativo. |
| `POST` | `/api/v1/admin/categories` | Administrativo | Cria uma nova categoria. |
| `GET` | `/api/v1/admin/categories/{id}` | Administrativo | Busca uma categoria por ID. |
| `PUT/PATCH` | `/api/v1/admin/categories/{id}` | Administrativo | Atualiza uma categoria existente. |
| `DELETE` | `/api/v1/admin/categories/{id}` | Administrativo | Remove uma categoria sem posts vinculados. |
---
## 🔎 Filtros Disponíveis na Listagem de Posts
| Parâmetro | Tipo | Exemplo | Finalidade |
|---|---|---|---|
| `search` | string | `/api/v1/public/posts?search=Laravel` | Busca posts pelo título. |
| `category_id` | integer | `/api/v1/public/posts?category_id=1` | Filtra posts por ID da categoria. |
| `category_slug` | string | `/api/v1/public/posts?category_slug=tecnologia` | Filtra posts pelo slug da categoria. |
| `is_featured` | boolean | `/api/v1/public/posts?is_featured=true` | Filtra posts em destaque. |
| `status` | string | `/api/v1/public/posts?status=published` | Filtra por `draft` ou `published`. |
| `per_page` | integer | `/api/v1/public/posts?per_page=15` | Define a quantidade de itens por página. |
---
## 📤 Exemplos de Requisição e Resposta em JSON
### Criar Categoria
**Endpoint:** `POST /api/v1/admin/categories`
**Corpo da requisição:**
```json
{
"name": "Tecnologia",
"description": "Noticias sobre tecnologia, inovacao e software."
}
```
**Retorno esperado:**
```json
{
"data": {
"id": 1,
"name": "Tecnologia",
"slug": "tecnologia",
"description": "Noticias sobre tecnologia, inovacao e software.",
"posts_count": 0,
"created_at": "2026-05-28T16:17:19.000000Z",
"updated_at": "2026-05-28T16:17:19.000000Z"
}
}
```
### Criar Post
**Endpoint:** `POST /api/v1/admin/posts`
**Corpo da requisição:**
```json
{
"title": "Laravel 12 em Microsservicos",
"content": "Conteudo completo da noticia sobre Laravel 12 em uma arquitetura de microsservicos.",
"excerpt": "Resumo da noticia sobre Laravel 12.",
"category_id": 1,
"featured_image": "https://cdn.example.com/images/laravel.jpg",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28 10:00:00"
}
```
**Retorno esperado:**
```json
{
"data": {
"id": 1,
"title": "Laravel 12 em Microsservicos",
"slug": "laravel-12-em-microsservicos",
"content": "Conteudo completo da noticia sobre Laravel 12 em uma arquitetura de microsservicos.",
"excerpt": "Resumo da noticia sobre Laravel 12.",
"featured_image": "https://cdn.example.com/images/laravel.jpg",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28T10:00:00.000000Z",
"category": {
"id": 1,
"name": "Tecnologia",
"slug": "tecnologia",
"description": "Noticias sobre tecnologia, inovacao e software."
}
}
}
```
### Listar Posts Publicados
**Endpoint:** `GET /api/v1/public/posts`
**Retorno esperado:**
```json
{
"data": [
{
"id": 1,
"title": "Laravel 12 em Microsservicos",
"slug": "laravel-12-em-microsservicos",
"excerpt": "Resumo da noticia sobre Laravel 12.",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28T10:00:00.000000Z",
"category": {
"id": 1,
"name": "Tecnologia",
"slug": "tecnologia"
}
}
],
"links": {
"first": "http://127.0.0.1:8000/api/v1/public/posts?page=1",
"last": "http://127.0.0.1:8000/api/v1/public/posts?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"per_page": 15,
"total": 1
}
}
```
### Excluir Post
**Endpoint:** `DELETE /api/v1/admin/posts/1`
**Retorno esperado:**
```json
{
"message": "Post deleted successfully."
}
```
---
## 📥 Dados Recebidos e Retornados
O serviço recebe dados relacionados às entidades **Categoria** e **Post**. As respostas são retornadas em JSON e seguem uma estrutura padronizada por meio de API Resources.
| Entidade | Dados Recebidos |
|---|---|
| Categoria | `name`, `slug` opcional, `description` |
| Post | `title`, `slug` opcional, `content`, `excerpt`, `category_id`, `featured_image`, `is_featured`, `status`, `published_at` |
| Resposta | Dados Retornados |
|---|---|
| Categoria | `id`, `name`, `slug`, `description`, `posts_count`, `created_at`, `updated_at` |
| Post | `id`, `title`, `slug`, `content`, `excerpt`, `featured_image`, `is_featured`, `status`, `published_at`, `category`, `created_at`, `updated_at` |
| Paginação | `data`, `links`, `meta` |
---
## 🔗 Integrações com Outros Microsserviços
Este serviço trabalha de forma desacoplada, mas foi projetado para integrar um ecossistema maior. Nesta versão, a integração real implementada é com seu próprio banco de dados. As demais integrações estão documentadas como evolução futura.
| Serviço | Tipo de Integração | Situação | Descrição |
|---|---|---|---|
| **Banco MySQL/MariaDB** | Consumo direto | Implementado | Armazena posts, categorias e metadados. |
| **Auth Service** | Consumo futuro | Preparado | Poderá validar tokens JWT para proteger rotas administrativas. |
| **API Gateway** | Consumidor da API | Previsto | Poderá centralizar chamadas para o BLOG-API. |
| **Frontend Web/Mobile** | Consumidor da API | Previsto | Poderá exibir posts, categorias, destaques e buscas. |
| **Notification Service** | Consumidor futuro | Previsto | Poderá notificar usuários quando novos posts forem publicados. |
| **Search Service** | Consumidor futuro | Previsto | Poderá indexar posts publicados para busca global. |
| **Media/Storage Service** | Consumo futuro | Previsto | Poderá armazenar imagens usadas no campo `featured_image`. |
---
## 🔄 Fluxo Principal do Serviço
O fluxo principal começa quando um administrador cria uma categoria e cadastra um post vinculado a ela. O BLOG-API valida os dados recebidos, gera o slug automaticamente, salva o conteúdo no banco e disponibiliza o post nas rotas públicas quando o status está como `published`.
```text
Administrador cadastra categoria
Administrador publica notícia
BLOG-API valida, gera slug e salva no banco
Frontend/Gateway consulta /api/v1/public/posts
Usuário visualiza notícia publicada
Serviços de busca/notificação podem consumir o conteúdo publicado
```
| Etapa | Descrição |
|---|---|
| 1 | O administrador cria uma categoria, como `Tecnologia`. |
| 2 | O administrador cria um post vinculado à categoria. |
| 3 | O serviço valida os dados usando Form Requests. |
| 4 | O sistema gera automaticamente os slugs. |
| 5 | O post é salvo como `draft` ou `published`. |
| 6 | Se estiver publicado, o post aparece nas rotas públicas. |
| 7 | Frontend, gateway ou outros serviços consomem a listagem. |
---
## ⚠️ Possíveis Erros e Retornos Esperados
Caso algo saia do fluxo ideal, a API retorna códigos HTTP e mensagens adequadas para facilitar o tratamento pelo cliente.
| Situação | Código HTTP | Exemplo de Retorno |
|---|---:|---|
| Dados inválidos | `422` | Campos obrigatórios ausentes ou em formato inválido. |
| Post inexistente | `404` | Registro de post não encontrado. |
| Categoria inexistente | `404` | Registro de categoria não encontrado. |
| Categoria com posts vinculados | `409` | Exclusão bloqueada por conflito de integridade. |
| Erro interno | `500` | Erro inesperado no servidor. |
| Banco indisponível | `503` | Falha no health check do banco de dados. |
### Exemplo de Erro de Validação
```json
{
"message": "The title field is required.",
"errors": {
"title": [
"The title field is required."
]
}
}
```
### Exemplo de Categoria com Posts Vinculados
```json
{
"message": "Category cannot be deleted because it has posts associated."
}
```
---
## 🧾 Arquivos Principais do Projeto
| Arquivo | Responsabilidade |
|---|---|
| `app/Models/Post.php` | Model de posts com relacionamento, casts e slug automático. |
| `app/Models/Category.php` | Model de categorias com relacionamento e slug automático. |
| `app/Http/Controllers/Api/PostController.php` | CRUD, filtros, paginação e respostas de posts. |
| `app/Http/Controllers/Api/CategoryController.php` | CRUD e validações de integridade das categorias. |
| `app/Http/Requests/PostRequest.php` | Validação dos dados de posts. |
| `app/Http/Requests/CategoryRequest.php` | Validação dos dados de categorias. |
| `app/Http/Resources/PostResource.php` | Padronização do JSON de posts. |
| `app/Http/Resources/CategoryResource.php` | Padronização do JSON de categorias. |
| `database/migrations/*create_categories_table.php` | Estrutura da tabela `categories`. |
| `database/migrations/*create_posts_table.php` | Estrutura da tabela `posts`. |
| `routes/api.php` | Rotas versionadas da API. |
| `routes/web.php` | Dashboard simples com rotas disponíveis. |
---
## ✅ Checklist de Entrega
| Item Obrigatório | Situação |
|---|---|
| Link do repositório | Atendido. |
| README completo | Atendido por este arquivo. |
| `.env.example` | Atendido e deve ser versionado. |
| `.env` real fora do Git | Atendido pelo `.gitignore`. |
| Documentação das rotas | Atendido. |
| Exemplos JSON | Atendido. |
| Explicação das integrações | Atendido. |
| Fluxo principal do serviço | Atendido. |
| Como executar localmente | Atendido. |
| Como testar localmente | Atendido. |
| Dockerfile e docker-compose.yml | Não aplicável nesta entrega sem Docker. |
---
## 📚 Referências
- [Laravel 12 Documentation](https://laravel.com/docs/12.x)
- [Composer Documentation](https://getcomposer.org/doc/)
- [PHP Manual](https://www.php.net/manual/pt_BR/)
- [MySQL Documentation](https://dev.mysql.com/doc/)
---
## 📌 Observação Final
Este microserviço está funcional localmente e foi testado com rotas de health check, CRUD de categorias, CRUD de posts, filtros públicos, paginação, slugs automáticos, status de publicação e posts em destaque.

132
README_IMPLEMENTACAO.md Normal file
View File

@@ -0,0 +1,132 @@
# Blog API — Microserviço Laravel 12
Este pacote contém a implementação completa de uma API profissional para um microserviço de **Blog/Notícias** em Laravel 12. A estrutura segue a separação esperada entre **Models**, **Migrations**, **Controllers**, **Form Requests**, **API Resources** e **Routes**, com rotas públicas, grupo administrativo preparado para JWT, health checks e dashboard web simples.
## Estrutura gerada
| Caminho | Finalidade |
|---|---|
| `app/Models/Post.php` | Model de posts, relacionamento com categoria, casts e slug automático único. |
| `app/Models/Category.php` | Model de categorias, relacionamento com posts e slug automático único. |
| `database/migrations/2026_05_28_000001_create_categories_table.php` | Migration da tabela `categories`. |
| `database/migrations/2026_05_28_000002_create_posts_table.php` | Migration da tabela `posts`. |
| `app/Http/Requests/PostRequest.php` | Validação para criação e atualização de posts. |
| `app/Http/Requests/CategoryRequest.php` | Validação para criação e atualização de categorias. |
| `app/Http/Resources/PostResource.php` | Serialização padronizada dos posts. |
| `app/Http/Resources/CategoryResource.php` | Serialização padronizada das categorias. |
| `app/Http/Controllers/Api/PostController.php` | CRUD completo de posts, filtros, paginação e tratamento de erros. |
| `app/Http/Controllers/Api/CategoryController.php` | CRUD completo de categorias e tratamento de integridade. |
| `routes/api.php` | Rotas versionadas em `/api/v1`, públicas e administrativas. |
| `routes/web.php` | Dashboard simples com as rotas disponíveis. |
| `resources/views/api-dashboard.blade.php` | View Blade do dashboard web. |
## Comandos para aplicar no projeto existente
Partindo do projeto já criado com `composer create-project laravel/laravel blog-api`, copie os arquivos deste pacote para a raiz do projeto e execute:
```bash
cd blog-api
composer install
cp .env.example .env
php artisan key:generate
```
Configure o banco de dados no arquivo `.env`. Em ambiente local, uma opção simples é usar SQLite:
```bash
touch database/database.sqlite
```
No `.env`, ajuste:
```dotenv
DB_CONNECTION=sqlite
# Remova ou comente DB_HOST, DB_PORT, DB_DATABASE, DB_USERNAME e DB_PASSWORD se necessário.
```
Em seguida, rode as migrations:
```bash
php artisan migrate
php artisan serve
```
> Em projetos Laravel 11/12, dependendo de como o projeto foi criado, o arquivo `routes/api.php` pode não estar registrado automaticamente. Se as rotas `/api/*` não aparecerem em `php artisan route:list`, execute `php artisan install:api` ou registre o arquivo `routes/api.php` no `bootstrap/app.php` usando o parâmetro `api` em `withRouting`.
## Rotas principais
| Método | Endpoint | Descrição |
|---|---|---|
| `GET` | `/api/v1/health` | Health check do serviço. |
| `GET` | `/api/v1/health-check-db` | Health check da conexão com banco de dados. |
| `GET` | `/api/v1/public/posts` | Lista posts com filtros e paginação. |
| `GET` | `/api/v1/public/posts/{slug}` | Exibe post público pelo slug. |
| `GET` | `/api/v1/public/categories` | Lista categorias. |
| `GET` | `/api/v1/public/categories/{slug}` | Exibe categoria pública pelo slug. |
| `GET` | `/api/v1/admin/posts` | Lista posts no grupo administrativo. |
| `POST` | `/api/v1/admin/posts` | Cria post. |
| `GET` | `/api/v1/admin/posts/{post}` | Exibe post por ID. |
| `PUT/PATCH` | `/api/v1/admin/posts/{post}` | Atualiza post. |
| `DELETE` | `/api/v1/admin/posts/{post}` | Remove post. |
| `apiResource` | `/api/v1/admin/categories` | CRUD completo de categorias. |
## Filtros de posts
A listagem de posts aceita os seguintes query parameters:
| Parâmetro | Exemplo | Descrição |
|---|---|---|
| `search` | `/api/v1/public/posts?search=Laravel` | Busca por título. |
| `category_id` | `/api/v1/public/posts?category_id=1` | Filtra por ID da categoria. |
| `category_slug` | `/api/v1/public/posts?category_slug=tecnologia` | Filtra por slug da categoria. |
| `is_featured` | `/api/v1/public/posts?is_featured=true` | Filtra posts em destaque. |
| `status` | `/api/v1/public/posts?status=published` | Filtra por `draft` ou `published`. |
| `per_page` | `/api/v1/public/posts?per_page=15` | Define a quantidade por página. |
## Exemplo de JSON para criar uma categoria
```json
{
"name": "Tecnologia",
"description": "Notícias sobre tecnologia, inovação, software e produtos digitais."
}
```
Endpoint:
```http
POST /api/v1/admin/categories
Content-Type: application/json
Accept: application/json
```
## Exemplo de JSON para criar um post
```json
{
"title": "Laravel 12 em Arquiteturas de Microsserviços",
"content": "Conteúdo completo da notícia, com contexto, análise e detalhes técnicos relevantes para o público do blog.",
"excerpt": "Uma visão prática sobre o uso de Laravel 12 em microsserviços modernos.",
"category_id": 1,
"featured_image": "https://cdn.example.com/images/laravel-12-microservices.jpg",
"is_featured": true,
"status": "published",
"published_at": "2026-05-28 10:00:00"
}
```
Endpoint:
```http
POST /api/v1/admin/posts
Content-Type: application/json
Accept: application/json
```
## Observações profissionais
A coluna `category_id` foi configurada com `restrictOnDelete` para evitar remoção acidental de categorias já vinculadas a posts. O controller de categorias também retorna HTTP `409 Conflict` quando uma remoção inválida é solicitada.
Os slugs são gerados automaticamente quando não são enviados pelo cliente. Caso já exista um slug igual, o sistema acrescenta sufixos incrementais, como `laravel-12`, `laravel-12-1` e `laravel-12-2`.
O grupo administrativo está preparado para futura autenticação JWT. Para ativá-la depois, basta instalar/configurar o guard desejado e descomentar/adaptar o middleware no grupo `/api/v1/admin` em `routes/api.php`.

View File

@@ -0,0 +1,144 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Requests\CategoryRequest;
use App\Http\Resources\CategoryResource;
use App\Models\Category;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
use Illuminate\Support\Facades\Log;
use Throwable;
class CategoryController extends Controller
{
/**
* List categories.
*
* @group Categories
*
* @queryParam search string Filter categories by name. Example: tecnologia
* @queryParam per_page integer Number of items per page. Default: 15. Example: 15
*/
public function index(Request $request): AnonymousResourceCollection|JsonResponse
{
try {
$categories = Category::query()
->withCount('posts')
->when($request->filled('search'), function ($query) use ($request): void {
$query->where('name', 'like', '%' . $request->string('search') . '%');
})
->orderBy('name')
->paginate((int) $request->integer('per_page', 15));
return CategoryResource::collection($categories);
} catch (Throwable $throwable) {
Log::error('Failed to list categories.', ['exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível listar as categorias.',
], 500);
}
}
/**
* Create category.
*
* @group Categories
*
* @bodyParam name string required Category name. Example: Tecnologia
* @bodyParam slug string Optional custom slug. Example: tecnologia
* @bodyParam description string Category description. Example: Notícias sobre tecnologia e inovação.
*/
public function store(CategoryRequest $request): CategoryResource|JsonResponse
{
try {
$data = $request->validated();
$category = Category::query()->create($data);
return (new CategoryResource($category))
->additional(['message' => 'Categoria criada com sucesso.'])
->response()
->setStatusCode(201);
} catch (Throwable $throwable) {
Log::error('Failed to create category.', ['exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível criar a categoria.',
], 500);
}
}
/**
* Show category.
*
* @group Categories
*/
public function show(Category $category): CategoryResource
{
$category->loadCount('posts');
return new CategoryResource($category);
}
/**
* Update category.
*
* @group Categories
*
* @bodyParam name string required Category name. Example: Tecnologia
* @bodyParam slug string Optional custom slug. Example: tecnologia
* @bodyParam description string Category description. Example: Notícias sobre tecnologia e inovação.
*/
public function update(CategoryRequest $request, Category $category): CategoryResource|JsonResponse
{
try {
$data = $request->validated();
if ($request->filled('name') && ! $request->filled('slug')) {
$data['slug'] = Category::generateUniqueSlug($data['name'], $category->id);
}
$category->update($data);
return (new CategoryResource($category->refresh()->loadCount('posts')))
->additional(['message' => 'Categoria atualizada com sucesso.']);
} catch (Throwable $throwable) {
Log::error('Failed to update category.', ['category_id' => $category->id, 'exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível atualizar a categoria.',
], 500);
}
}
/**
* Delete category.
*
* @group Categories
*/
public function destroy(Category $category): JsonResponse
{
try {
if ($category->posts()->exists()) {
return response()->json([
'message' => 'Não é possível remover uma categoria vinculada a posts.',
], 409);
}
$category->delete();
return response()->json([
'message' => 'Categoria removida com sucesso.',
]);
} catch (Throwable $throwable) {
Log::error('Failed to delete category.', ['category_id' => $category->id, 'exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível remover a categoria.',
], 500);
}
}
}

View File

@@ -0,0 +1,171 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Http\Requests\PostRequest;
use App\Http\Resources\PostResource;
use App\Models\Post;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
use Illuminate\Support\Facades\Log;
use Throwable;
class PostController extends Controller
{
/**
* List posts.
*
* @group Posts
*
* @queryParam search string Filter posts by title. Example: Laravel
* @queryParam category_id integer Filter posts by category ID. Example: 1
* @queryParam category_slug string Filter posts by category slug. Example: tecnologia
* @queryParam is_featured boolean Filter featured posts. Example: true
* @queryParam status string Filter by status: draft or published. Example: published
* @queryParam per_page integer Number of items per page. Default: 15. Example: 15
*/
public function index(Request $request): AnonymousResourceCollection|JsonResponse
{
try {
$posts = Post::query()
->with('category')
->when($request->filled('search'), function ($query) use ($request): void {
$query->where('title', 'like', '%' . $request->string('search') . '%');
})
->when($request->filled('category_id'), function ($query) use ($request): void {
$query->where('category_id', $request->integer('category_id'));
})
->when($request->filled('category_slug'), function ($query) use ($request): void {
$query->whereHas('category', function ($categoryQuery) use ($request): void {
$categoryQuery->where('slug', $request->string('category_slug'));
});
})
->when($request->has('is_featured'), function ($query) use ($request): void {
$query->where('is_featured', $request->boolean('is_featured'));
})
->when($request->filled('status'), function ($query) use ($request): void {
$query->where('status', $request->string('status'));
})
->orderByDesc('published_at')
->orderByDesc('created_at')
->paginate((int) $request->integer('per_page', 15));
return PostResource::collection($posts);
} catch (Throwable $throwable) {
Log::error('Failed to list posts.', ['exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível listar os posts.',
], 500);
}
}
/**
* Create post.
*
* @group Posts
*
* @bodyParam title string required Post title. Example: Laravel 12 em Microsserviços
* @bodyParam slug string Optional custom slug. Example: laravel-12-em-microsservicos
* @bodyParam content string required Full post content. Example: Conteúdo completo da notícia.
* @bodyParam excerpt string Short post excerpt. Example: Resumo da notícia.
* @bodyParam category_id integer required Category ID. Example: 1
* @bodyParam featured_image string URL of featured image. Example: https://cdn.example.com/image.jpg
* @bodyParam is_featured boolean Whether the post is featured. Example: true
* @bodyParam status string required draft or published. Example: published
* @bodyParam published_at datetime Publication date. Example: 2026-05-28 10:00:00
*/
public function store(PostRequest $request): PostResource|JsonResponse
{
try {
$data = $request->validated();
$post = Post::query()->create($data);
$post->load('category');
return (new PostResource($post))
->additional(['message' => 'Post criado com sucesso.'])
->response()
->setStatusCode(201);
} catch (Throwable $throwable) {
Log::error('Failed to create post.', ['exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível criar o post.',
], 500);
}
}
/**
* Show post.
*
* @group Posts
*/
public function show(Post $post): PostResource
{
$post->load('category');
return new PostResource($post);
}
/**
* Update post.
*
* @group Posts
*
* @bodyParam title string required Post title. Example: Laravel 12 em Microsserviços
* @bodyParam slug string Optional custom slug. Example: laravel-12-em-microsservicos
* @bodyParam content string required Full post content. Example: Conteúdo completo da notícia.
* @bodyParam excerpt string Short post excerpt. Example: Resumo da notícia.
* @bodyParam category_id integer required Category ID. Example: 1
* @bodyParam featured_image string URL of featured image. Example: https://cdn.example.com/image.jpg
* @bodyParam is_featured boolean Whether the post is featured. Example: true
* @bodyParam status string required draft or published. Example: published
* @bodyParam published_at datetime Publication date. Example: 2026-05-28 10:00:00
*/
public function update(PostRequest $request, Post $post): PostResource|JsonResponse
{
try {
$data = $request->validated();
if ($request->filled('title') && ! $request->filled('slug')) {
$data['slug'] = Post::generateUniqueSlug($data['title'], $post->id);
}
$post->update($data);
$post->refresh()->load('category');
return (new PostResource($post))
->additional(['message' => 'Post atualizado com sucesso.']);
} catch (Throwable $throwable) {
Log::error('Failed to update post.', ['post_id' => $post->id, 'exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível atualizar o post.',
], 500);
}
}
/**
* Delete post.
*
* @group Posts
*/
public function destroy(Post $post): JsonResponse
{
try {
$post->delete();
return response()->json([
'message' => 'Post removido com sucesso.',
]);
} catch (Throwable $throwable) {
Log::error('Failed to delete post.', ['post_id' => $post->id, 'exception' => $throwable]);
return response()->json([
'message' => 'Não foi possível remover o post.',
], 500);
}
}
}

View File

@@ -0,0 +1,8 @@
<?php
namespace App\Http\Controllers;
abstract class Controller
{
//
}

View File

@@ -0,0 +1,54 @@
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;
class CategoryRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules(): array
{
$categoryId = $this->route('category')?->id;
$nameRule = $this->isMethod('post') ? 'required' : 'sometimes';
return [
'name' => [$nameRule, 'string', 'max:255'],
'slug' => [
'nullable',
'string',
'max:255',
'alpha_dash:ascii',
Rule::unique('categories', 'slug')->ignore($categoryId),
],
'description' => ['nullable', 'string'],
];
}
/**
* Get custom attributes for validator errors.
*
* @return array<string, string>
*/
public function attributes(): array
{
return [
'name' => 'nome',
'slug' => 'slug',
'description' => 'descrição',
];
}
}

View File

@@ -0,0 +1,86 @@
<?php
namespace App\Http\Requests;
use App\Models\Post;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Validation\Rule;
class PostRequest extends FormRequest
{
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
return true;
}
/**
* Get the validation rules that apply to the request.
*
* @return array<string, mixed>
*/
public function rules(): array
{
$postId = $this->route('post')?->id;
$requiredOnCreate = $this->isMethod('post') ? 'required' : 'sometimes';
return [
'title' => [$requiredOnCreate, 'string', 'max:255'],
'slug' => [
'nullable',
'string',
'max:255',
'alpha_dash:ascii',
Rule::unique('posts', 'slug')->ignore($postId),
],
'content' => [$requiredOnCreate, 'string'],
'excerpt' => ['nullable', 'string', 'max:1000'],
'category_id' => [$requiredOnCreate, 'integer', 'exists:categories,id'],
'featured_image' => ['nullable', 'url', 'max:2048'],
'is_featured' => ['sometimes', 'boolean'],
'status' => [$requiredOnCreate, Rule::in([Post::STATUS_DRAFT, Post::STATUS_PUBLISHED])],
'published_at' => ['nullable', 'date'],
];
}
/**
* Configure the validator instance.
*/
public function withValidator($validator): void
{
$validator->after(function ($validator): void {
$post = $this->route('post');
$status = $this->input('status', $post?->status);
$publishedAt = $this->input('published_at', $post?->published_at);
if ($status === Post::STATUS_PUBLISHED && blank($publishedAt)) {
$validator->errors()->add(
'published_at',
'A data de publicação é obrigatória quando o status do post é published.'
);
}
});
}
/**
* Get custom attributes for validator errors.
*
* @return array<string, string>
*/
public function attributes(): array
{
return [
'title' => 'título',
'slug' => 'slug',
'content' => 'conteúdo',
'excerpt' => 'resumo',
'category_id' => 'categoria',
'featured_image' => 'imagem destacada',
'is_featured' => 'post em destaque',
'status' => 'status',
'published_at' => 'data de publicação',
];
}
}

View File

@@ -0,0 +1,27 @@
<?php
namespace App\Http\Resources;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
class CategoryResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @return array<string, mixed>
*/
public function toArray(Request $request): array
{
return [
'id' => $this->id,
'name' => $this->name,
'slug' => $this->slug,
'description' => $this->description,
'posts_count' => $this->whenCounted('posts'),
'created_at' => $this->created_at?->toISOString(),
'updated_at' => $this->updated_at?->toISOString(),
];
}
}

View File

@@ -0,0 +1,32 @@
<?php
namespace App\Http\Resources;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
class PostResource extends JsonResource
{
/**
* Transform the resource into an array.
*
* @return array<string, mixed>
*/
public function toArray(Request $request): array
{
return [
'id' => $this->id,
'title' => $this->title,
'slug' => $this->slug,
'content' => $this->content,
'excerpt' => $this->excerpt,
'featured_image' => $this->featured_image,
'is_featured' => (bool) $this->is_featured,
'status' => $this->status,
'published_at' => $this->published_at?->toISOString(),
'category' => new CategoryResource($this->whenLoaded('category')),
'created_at' => $this->created_at?->toISOString(),
'updated_at' => $this->updated_at?->toISOString(),
];
}
}

70
app/Models/Category.php Normal file
View File

@@ -0,0 +1,70 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Str;
class Category extends Model
{
use HasFactory;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'slug',
'description',
];
/**
* Boot the model and register model events.
*/
protected static function booted(): void
{
static::creating(function (Category $category): void {
if (blank($category->slug)) {
$category->slug = static::generateUniqueSlug($category->name);
}
});
static::updating(function (Category $category): void {
if ($category->isDirty('name') && blank($category->slug)) {
$category->slug = static::generateUniqueSlug($category->name, $category->id);
}
});
}
/**
* Get the posts associated with the category.
*/
public function posts(): HasMany
{
return $this->hasMany(Post::class);
}
/**
* Generate a unique slug based on the category name.
*/
public static function generateUniqueSlug(string $name, ?int $ignoreId = null): string
{
$baseSlug = Str::slug($name);
$slug = $baseSlug;
$counter = 1;
while (static::query()
->where('slug', $slug)
->when($ignoreId, fn ($query) => $query->whereKeyNot($ignoreId))
->exists()) {
$slug = "{$baseSlug}-{$counter}";
$counter++;
}
return $slug;
}
}

100
app/Models/Post.php Normal file
View File

@@ -0,0 +1,100 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Support\Str;
class Post extends Model
{
use HasFactory;
public const STATUS_DRAFT = 'draft';
public const STATUS_PUBLISHED = 'published';
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'title',
'slug',
'content',
'excerpt',
'category_id',
'featured_image',
'is_featured',
'status',
'published_at',
];
/**
* The attributes that should be cast.
*
* @return array<string, string>
*/
protected function casts(): array
{
return [
'is_featured' => 'boolean',
'published_at' => 'datetime',
];
}
/**
* Boot the model and register model events.
*/
protected static function booted(): void
{
static::creating(function (Post $post): void {
if (blank($post->slug)) {
$post->slug = static::generateUniqueSlug($post->title);
}
});
static::updating(function (Post $post): void {
if ($post->isDirty('title') && blank($post->slug)) {
$post->slug = static::generateUniqueSlug($post->title, $post->id);
}
});
}
/**
* Get the category that owns the post.
*/
public function category(): BelongsTo
{
return $this->belongsTo(Category::class);
}
/**
* Generate a unique slug based on the post title.
*/
public static function generateUniqueSlug(string $title, ?int $ignoreId = null): string
{
$baseSlug = Str::slug($title);
$slug = $baseSlug;
$counter = 1;
while (static::query()
->where('slug', $slug)
->when($ignoreId, fn ($query) => $query->whereKeyNot($ignoreId))
->exists()) {
$slug = "{$baseSlug}-{$counter}";
$counter++;
}
return $slug;
}
/**
* Determine whether the post is published.
*/
public function isPublished(): bool
{
return $this->status === self::STATUS_PUBLISHED;
}
}

49
app/Models/User.php Normal file
View File

@@ -0,0 +1,49 @@
<?php
namespace App\Models;
// use Illuminate\Contracts\Auth\MustVerifyEmail;
use Database\Factories\UserFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
class User extends Authenticatable
{
/** @use HasFactory<UserFactory> */
use HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var list<string>
*/
protected $fillable = [
'name',
'email',
'password',
];
/**
* The attributes that should be hidden for serialization.
*
* @var list<string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* Get the attributes that should be cast.
*
* @return array<string, string>
*/
protected function casts(): array
{
return [
'email_verified_at' => 'datetime',
'password' => 'hashed',
];
}
}

View File

@@ -0,0 +1,24 @@
<?php
namespace App\Providers;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*/
public function register(): void
{
//
}
/**
* Bootstrap any application services.
*/
public function boot(): void
{
//
}
}

18
artisan Normal file
View File

@@ -0,0 +1,18 @@
#!/usr/bin/env php
<?php
use Illuminate\Foundation\Application;
use Symfony\Component\Console\Input\ArgvInput;
define('LARAVEL_START', microtime(true));
// Register the Composer autoloader...
require __DIR__.'/vendor/autoload.php';
// Bootstrap Laravel and handle the command...
/** @var Application $app */
$app = require_once __DIR__.'/bootstrap/app.php';
$status = $app->handleCommand(new ArgvInput);
exit($status);

19
bootstrap/app.php Normal file
View File

@@ -0,0 +1,19 @@
<?php
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware): void {
//
})
->withExceptions(function (Exceptions $exceptions): void {
//
})->create();

2
bootstrap/cache/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

7
bootstrap/providers.php Normal file
View File

@@ -0,0 +1,7 @@
<?php
use App\Providers\AppServiceProvider;
return [
AppServiceProvider::class,
];

87
composer.json Normal file
View File

@@ -0,0 +1,87 @@
{
"$schema": "https://getcomposer.org/schema.json",
"name": "laravel/laravel",
"type": "project",
"description": "The skeleton application for the Laravel framework.",
"keywords": ["laravel", "framework"],
"license": "MIT",
"require": {
"php": "^8.2",
"laravel/framework": "^12.0",
"laravel/sanctum": "^4.0",
"laravel/tinker": "^2.10.1"
},
"require-dev": {
"fakerphp/faker": "^1.23",
"laravel/pail": "^1.2.2",
"laravel/pint": "^1.24",
"laravel/sail": "^1.41",
"mockery/mockery": "^1.6",
"nunomaduro/collision": "^8.6",
"phpunit/phpunit": "^11.5.50"
},
"autoload": {
"psr-4": {
"App\\": "app/",
"Database\\Factories\\": "database/factories/",
"Database\\Seeders\\": "database/seeders/"
}
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
}
},
"scripts": {
"setup": [
"composer install",
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\"",
"@php artisan key:generate",
"@php artisan migrate --force",
"npm install",
"npm run build"
],
"dev": [
"Composer\\Config::disableProcessTimeout",
"npx concurrently -c \"#93c5fd,#c4b5fd,#fb7185,#fdba74\" \"php artisan serve\" \"php artisan queue:listen --tries=1 --timeout=0\" \"php artisan pail --timeout=0\" \"npm run dev\" --names=server,queue,logs,vite --kill-others"
],
"test": [
"@php artisan config:clear --ansi",
"@php artisan test"
],
"post-autoload-dump": [
"Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
"@php artisan package:discover --ansi"
],
"post-update-cmd": [
"@php artisan vendor:publish --tag=laravel-assets --ansi --force"
],
"post-root-package-install": [
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
],
"post-create-project-cmd": [
"@php artisan key:generate --ansi",
"@php -r \"file_exists('database/database.sqlite') || touch('database/database.sqlite');\"",
"@php artisan migrate --graceful --ansi"
],
"pre-package-uninstall": [
"Illuminate\\Foundation\\ComposerScripts::prePackageUninstall"
]
},
"extra": {
"laravel": {
"dont-discover": []
}
},
"config": {
"optimize-autoloader": true,
"preferred-install": "dist",
"sort-packages": true,
"allow-plugins": {
"pestphp/pest-plugin": true,
"php-http/discovery": true
}
},
"minimum-stability": "stable",
"prefer-stable": true
}

8471
composer.lock generated Normal file

File diff suppressed because it is too large Load Diff

126
config/app.php Normal file
View File

@@ -0,0 +1,126 @@
<?php
return [
/*
|--------------------------------------------------------------------------
| Application Name
|--------------------------------------------------------------------------
|
| This value is the name of your application, which will be used when the
| framework needs to place the application's name in a notification or
| other UI elements where an application name needs to be displayed.
|
*/
'name' => env('APP_NAME', 'Laravel'),
/*
|--------------------------------------------------------------------------
| Application Environment
|--------------------------------------------------------------------------
|
| This value determines the "environment" your application is currently
| running in. This may determine how you prefer to configure various
| services the application utilizes. Set this in your ".env" file.
|
*/
'env' => env('APP_ENV', 'production'),
/*
|--------------------------------------------------------------------------
| Application Debug Mode
|--------------------------------------------------------------------------
|
| When your application is in debug mode, detailed error messages with
| stack traces will be shown on every error that occurs within your
| application. If disabled, a simple generic error page is shown.
|
*/
'debug' => (bool) env('APP_DEBUG', false),
/*
|--------------------------------------------------------------------------
| Application URL
|--------------------------------------------------------------------------
|
| This URL is used by the console to properly generate URLs when using
| the Artisan command line tool. You should set this to the root of
| the application so that it's available within Artisan commands.
|
*/
'url' => env('APP_URL', 'http://localhost'),
/*
|--------------------------------------------------------------------------
| Application Timezone
|--------------------------------------------------------------------------
|
| Here you may specify the default timezone for your application, which
| will be used by the PHP date and date-time functions. The timezone
| is set to "UTC" by default as it is suitable for most use cases.
|
*/
'timezone' => 'UTC',
/*
|--------------------------------------------------------------------------
| Application Locale Configuration
|--------------------------------------------------------------------------
|
| The application locale determines the default locale that will be used
| by Laravel's translation / localization methods. This option can be
| set to any locale for which you plan to have translation strings.
|
*/
'locale' => env('APP_LOCALE', 'en'),
'fallback_locale' => env('APP_FALLBACK_LOCALE', 'en'),
'faker_locale' => env('APP_FAKER_LOCALE', 'en_US'),
/*
|--------------------------------------------------------------------------
| Encryption Key
|--------------------------------------------------------------------------
|
| This key is utilized by Laravel's encryption services and should be set
| to a random, 32 character string to ensure that all encrypted values
| are secure. You should do this prior to deploying the application.
|
*/
'cipher' => 'AES-256-CBC',
'key' => env('APP_KEY'),
'previous_keys' => [
...array_filter(
explode(',', (string) env('APP_PREVIOUS_KEYS', ''))
),
],
/*
|--------------------------------------------------------------------------
| Maintenance Mode Driver
|--------------------------------------------------------------------------
|
| These configuration options determine the driver used to determine and
| manage Laravel's "maintenance mode" status. The "cache" driver will
| allow maintenance mode to be controlled across multiple machines.
|
| Supported drivers: "file", "cache"
|
*/
'maintenance' => [
'driver' => env('APP_MAINTENANCE_DRIVER', 'file'),
'store' => env('APP_MAINTENANCE_STORE', 'database'),
],
];

117
config/auth.php Normal file
View File

@@ -0,0 +1,117 @@
<?php
use App\Models\User;
return [
/*
|--------------------------------------------------------------------------
| Authentication Defaults
|--------------------------------------------------------------------------
|
| This option defines the default authentication "guard" and password
| reset "broker" for your application. You may change these values
| as required, but they're a perfect start for most applications.
|
*/
'defaults' => [
'guard' => env('AUTH_GUARD', 'web'),
'passwords' => env('AUTH_PASSWORD_BROKER', 'users'),
],
/*
|--------------------------------------------------------------------------
| Authentication Guards
|--------------------------------------------------------------------------
|
| Next, you may define every authentication guard for your application.
| Of course, a great default configuration has been defined for you
| which utilizes session storage plus the Eloquent user provider.
|
| All authentication guards have a user provider, which defines how the
| users are actually retrieved out of your database or other storage
| system used by the application. Typically, Eloquent is utilized.
|
| Supported: "session"
|
*/
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
],
/*
|--------------------------------------------------------------------------
| User Providers
|--------------------------------------------------------------------------
|
| All authentication guards have a user provider, which defines how the
| users are actually retrieved out of your database or other storage
| system used by the application. Typically, Eloquent is utilized.
|
| If you have multiple user tables or models you may configure multiple
| providers to represent the model / table. These providers may then
| be assigned to any extra authentication guards you have defined.
|
| Supported: "database", "eloquent"
|
*/
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => env('AUTH_MODEL', User::class),
],
// 'users' => [
// 'driver' => 'database',
// 'table' => 'users',
// ],
],
/*
|--------------------------------------------------------------------------
| Resetting Passwords
|--------------------------------------------------------------------------
|
| These configuration options specify the behavior of Laravel's password
| reset functionality, including the table utilized for token storage
| and the user provider that is invoked to actually retrieve users.
|
| The expiry time is the number of minutes that each reset token will be
| considered valid. This security feature keeps tokens short-lived so
| they have less time to be guessed. You may change this as needed.
|
| The throttle setting is the number of seconds a user must wait before
| generating more password reset tokens. This prevents the user from
| quickly generating a very large amount of password reset tokens.
|
*/
'passwords' => [
'users' => [
'provider' => 'users',
'table' => env('AUTH_PASSWORD_RESET_TOKEN_TABLE', 'password_reset_tokens'),
'expire' => 60,
'throttle' => 60,
],
],
/*
|--------------------------------------------------------------------------
| Password Confirmation Timeout
|--------------------------------------------------------------------------
|
| Here you may define the number of seconds before a password confirmation
| window expires and users are asked to re-enter their password via the
| confirmation screen. By default, the timeout lasts for three hours.
|
*/
'password_timeout' => env('AUTH_PASSWORD_TIMEOUT', 10800),
];

117
config/cache.php Normal file
View File

@@ -0,0 +1,117 @@
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Cache Store
|--------------------------------------------------------------------------
|
| This option controls the default cache store that will be used by the
| framework. This connection is utilized if another isn't explicitly
| specified when running a cache operation inside the application.
|
*/
'default' => env('CACHE_STORE', 'database'),
/*
|--------------------------------------------------------------------------
| Cache Stores
|--------------------------------------------------------------------------
|
| Here you may define all of the cache "stores" for your application as
| well as their drivers. You may even define multiple stores for the
| same cache driver to group types of items stored in your caches.
|
| Supported drivers: "array", "database", "file", "memcached",
| "redis", "dynamodb", "octane",
| "failover", "null"
|
*/
'stores' => [
'array' => [
'driver' => 'array',
'serialize' => false,
],
'database' => [
'driver' => 'database',
'connection' => env('DB_CACHE_CONNECTION'),
'table' => env('DB_CACHE_TABLE', 'cache'),
'lock_connection' => env('DB_CACHE_LOCK_CONNECTION'),
'lock_table' => env('DB_CACHE_LOCK_TABLE'),
],
'file' => [
'driver' => 'file',
'path' => storage_path('framework/cache/data'),
'lock_path' => storage_path('framework/cache/data'),
],
'memcached' => [
'driver' => 'memcached',
'persistent_id' => env('MEMCACHED_PERSISTENT_ID'),
'sasl' => [
env('MEMCACHED_USERNAME'),
env('MEMCACHED_PASSWORD'),
],
'options' => [
// Memcached::OPT_CONNECT_TIMEOUT => 2000,
],
'servers' => [
[
'host' => env('MEMCACHED_HOST', '127.0.0.1'),
'port' => env('MEMCACHED_PORT', 11211),
'weight' => 100,
],
],
],
'redis' => [
'driver' => 'redis',
'connection' => env('REDIS_CACHE_CONNECTION', 'cache'),
'lock_connection' => env('REDIS_CACHE_LOCK_CONNECTION', 'default'),
],
'dynamodb' => [
'driver' => 'dynamodb',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
'endpoint' => env('DYNAMODB_ENDPOINT'),
],
'octane' => [
'driver' => 'octane',
],
'failover' => [
'driver' => 'failover',
'stores' => [
'database',
'array',
],
],
],
/*
|--------------------------------------------------------------------------
| Cache Key Prefix
|--------------------------------------------------------------------------
|
| When utilizing the APC, database, memcached, Redis, and DynamoDB cache
| stores, there might be other applications using the same cache. For
| that reason, you may prefix every cache key to avoid collisions.
|
*/
'prefix' => env('CACHE_PREFIX', Str::slug((string) env('APP_NAME', 'laravel')).'-cache-'),
];

184
config/database.php Normal file
View File

@@ -0,0 +1,184 @@
<?php
use Illuminate\Support\Str;
use Pdo\Mysql;
return [
/*
|--------------------------------------------------------------------------
| Default Database Connection Name
|--------------------------------------------------------------------------
|
| Here you may specify which of the database connections below you wish
| to use as your default connection for database operations. This is
| the connection which will be utilized unless another connection
| is explicitly specified when you execute a query / statement.
|
*/
'default' => env('DB_CONNECTION', 'sqlite'),
/*
|--------------------------------------------------------------------------
| Database Connections
|--------------------------------------------------------------------------
|
| Below are all of the database connections defined for your application.
| An example configuration is provided for each database system which
| is supported by Laravel. You're free to add / remove connections.
|
*/
'connections' => [
'sqlite' => [
'driver' => 'sqlite',
'url' => env('DB_URL'),
'database' => env('DB_DATABASE', database_path('database.sqlite')),
'prefix' => '',
'foreign_key_constraints' => env('DB_FOREIGN_KEYS', true),
'busy_timeout' => null,
'journal_mode' => null,
'synchronous' => null,
'transaction_mode' => 'DEFERRED',
],
'mysql' => [
'driver' => 'mysql',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'unix_socket' => env('DB_SOCKET', ''),
'charset' => env('DB_CHARSET', 'utf8mb4'),
'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
'prefix' => '',
'prefix_indexes' => true,
'strict' => true,
'engine' => null,
'options' => extension_loaded('pdo_mysql') ? array_filter([
(PHP_VERSION_ID >= 80500 ? Mysql::ATTR_SSL_CA : PDO::MYSQL_ATTR_SSL_CA) => env('MYSQL_ATTR_SSL_CA'),
]) : [],
],
'mariadb' => [
'driver' => 'mariadb',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'unix_socket' => env('DB_SOCKET', ''),
'charset' => env('DB_CHARSET', 'utf8mb4'),
'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
'prefix' => '',
'prefix_indexes' => true,
'strict' => true,
'engine' => null,
'options' => extension_loaded('pdo_mysql') ? array_filter([
(PHP_VERSION_ID >= 80500 ? Mysql::ATTR_SSL_CA : PDO::MYSQL_ATTR_SSL_CA) => env('MYSQL_ATTR_SSL_CA'),
]) : [],
],
'pgsql' => [
'driver' => 'pgsql',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '5432'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'charset' => env('DB_CHARSET', 'utf8'),
'prefix' => '',
'prefix_indexes' => true,
'search_path' => 'public',
'sslmode' => env('DB_SSLMODE', 'prefer'),
],
'sqlsrv' => [
'driver' => 'sqlsrv',
'url' => env('DB_URL'),
'host' => env('DB_HOST', 'localhost'),
'port' => env('DB_PORT', '1433'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'charset' => env('DB_CHARSET', 'utf8'),
'prefix' => '',
'prefix_indexes' => true,
// 'encrypt' => env('DB_ENCRYPT', 'yes'),
// 'trust_server_certificate' => env('DB_TRUST_SERVER_CERTIFICATE', 'false'),
],
],
/*
|--------------------------------------------------------------------------
| Migration Repository Table
|--------------------------------------------------------------------------
|
| This table keeps track of all the migrations that have already run for
| your application. Using this information, we can determine which of
| the migrations on disk haven't actually been run on the database.
|
*/
'migrations' => [
'table' => 'migrations',
'update_date_on_publish' => true,
],
/*
|--------------------------------------------------------------------------
| Redis Databases
|--------------------------------------------------------------------------
|
| Redis is an open source, fast, and advanced key-value store that also
| provides a richer body of commands than a typical key-value system
| such as Memcached. You may define your connection settings here.
|
*/
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug((string) env('APP_NAME', 'laravel')).'-database-'),
'persistent' => env('REDIS_PERSISTENT', false),
],
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
'max_retries' => env('REDIS_MAX_RETRIES', 3),
'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),
'backoff_base' => env('REDIS_BACKOFF_BASE', 100),
'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),
],
'cache' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_CACHE_DB', '1'),
'max_retries' => env('REDIS_MAX_RETRIES', 3),
'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),
'backoff_base' => env('REDIS_BACKOFF_BASE', 100),
'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),
],
],
];

80
config/filesystems.php Normal file
View File

@@ -0,0 +1,80 @@
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Filesystem Disk
|--------------------------------------------------------------------------
|
| Here you may specify the default filesystem disk that should be used
| by the framework. The "local" disk, as well as a variety of cloud
| based disks are available to your application for file storage.
|
*/
'default' => env('FILESYSTEM_DISK', 'local'),
/*
|--------------------------------------------------------------------------
| Filesystem Disks
|--------------------------------------------------------------------------
|
| Below you may configure as many filesystem disks as necessary, and you
| may even configure multiple disks for the same driver. Examples for
| most supported storage drivers are configured here for reference.
|
| Supported drivers: "local", "ftp", "sftp", "s3"
|
*/
'disks' => [
'local' => [
'driver' => 'local',
'root' => storage_path('app/private'),
'serve' => true,
'throw' => false,
'report' => false,
],
'public' => [
'driver' => 'local',
'root' => storage_path('app/public'),
'url' => rtrim(env('APP_URL', 'http://localhost'), '/').'/storage',
'visibility' => 'public',
'throw' => false,
'report' => false,
],
's3' => [
'driver' => 's3',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION'),
'bucket' => env('AWS_BUCKET'),
'url' => env('AWS_URL'),
'endpoint' => env('AWS_ENDPOINT'),
'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
'throw' => false,
'report' => false,
],
],
/*
|--------------------------------------------------------------------------
| Symbolic Links
|--------------------------------------------------------------------------
|
| Here you may configure the symbolic links that will be created when the
| `storage:link` Artisan command is executed. The array keys should be
| the locations of the links and the values should be their targets.
|
*/
'links' => [
public_path('storage') => storage_path('app/public'),
],
];

132
config/logging.php Normal file
View File

@@ -0,0 +1,132 @@
<?php
use Monolog\Handler\NullHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\SyslogUdpHandler;
use Monolog\Processor\PsrLogMessageProcessor;
return [
/*
|--------------------------------------------------------------------------
| Default Log Channel
|--------------------------------------------------------------------------
|
| This option defines the default log channel that is utilized to write
| messages to your logs. The value provided here should match one of
| the channels present in the list of "channels" configured below.
|
*/
'default' => env('LOG_CHANNEL', 'stack'),
/*
|--------------------------------------------------------------------------
| Deprecations Log Channel
|--------------------------------------------------------------------------
|
| This option controls the log channel that should be used to log warnings
| regarding deprecated PHP and library features. This allows you to get
| your application ready for upcoming major versions of dependencies.
|
*/
'deprecations' => [
'channel' => env('LOG_DEPRECATIONS_CHANNEL', 'null'),
'trace' => env('LOG_DEPRECATIONS_TRACE', false),
],
/*
|--------------------------------------------------------------------------
| Log Channels
|--------------------------------------------------------------------------
|
| Here you may configure the log channels for your application. Laravel
| utilizes the Monolog PHP logging library, which includes a variety
| of powerful log handlers and formatters that you're free to use.
|
| Available drivers: "single", "daily", "slack", "syslog",
| "errorlog", "monolog", "custom", "stack"
|
*/
'channels' => [
'stack' => [
'driver' => 'stack',
'channels' => explode(',', (string) env('LOG_STACK', 'single')),
'ignore_exceptions' => false,
],
'single' => [
'driver' => 'single',
'path' => storage_path('logs/laravel.log'),
'level' => env('LOG_LEVEL', 'debug'),
'replace_placeholders' => true,
],
'daily' => [
'driver' => 'daily',
'path' => storage_path('logs/laravel.log'),
'level' => env('LOG_LEVEL', 'debug'),
'days' => env('LOG_DAILY_DAYS', 14),
'replace_placeholders' => true,
],
'slack' => [
'driver' => 'slack',
'url' => env('LOG_SLACK_WEBHOOK_URL'),
'username' => env('LOG_SLACK_USERNAME', env('APP_NAME', 'Laravel')),
'emoji' => env('LOG_SLACK_EMOJI', ':boom:'),
'level' => env('LOG_LEVEL', 'critical'),
'replace_placeholders' => true,
],
'papertrail' => [
'driver' => 'monolog',
'level' => env('LOG_LEVEL', 'debug'),
'handler' => env('LOG_PAPERTRAIL_HANDLER', SyslogUdpHandler::class),
'handler_with' => [
'host' => env('PAPERTRAIL_URL'),
'port' => env('PAPERTRAIL_PORT'),
'connectionString' => 'tls://'.env('PAPERTRAIL_URL').':'.env('PAPERTRAIL_PORT'),
],
'processors' => [PsrLogMessageProcessor::class],
],
'stderr' => [
'driver' => 'monolog',
'level' => env('LOG_LEVEL', 'debug'),
'handler' => StreamHandler::class,
'handler_with' => [
'stream' => 'php://stderr',
],
'formatter' => env('LOG_STDERR_FORMATTER'),
'processors' => [PsrLogMessageProcessor::class],
],
'syslog' => [
'driver' => 'syslog',
'level' => env('LOG_LEVEL', 'debug'),
'facility' => env('LOG_SYSLOG_FACILITY', LOG_USER),
'replace_placeholders' => true,
],
'errorlog' => [
'driver' => 'errorlog',
'level' => env('LOG_LEVEL', 'debug'),
'replace_placeholders' => true,
],
'null' => [
'driver' => 'monolog',
'handler' => NullHandler::class,
],
'emergency' => [
'path' => storage_path('logs/laravel.log'),
],
],
];

118
config/mail.php Normal file
View File

@@ -0,0 +1,118 @@
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Mailer
|--------------------------------------------------------------------------
|
| This option controls the default mailer that is used to send all email
| messages unless another mailer is explicitly specified when sending
| the message. All additional mailers can be configured within the
| "mailers" array. Examples of each type of mailer are provided.
|
*/
'default' => env('MAIL_MAILER', 'log'),
/*
|--------------------------------------------------------------------------
| Mailer Configurations
|--------------------------------------------------------------------------
|
| Here you may configure all of the mailers used by your application plus
| their respective settings. Several examples have been configured for
| you and you are free to add your own as your application requires.
|
| Laravel supports a variety of mail "transport" drivers that can be used
| when delivering an email. You may specify which one you're using for
| your mailers below. You may also add additional mailers if needed.
|
| Supported: "smtp", "sendmail", "mailgun", "ses", "ses-v2",
| "postmark", "resend", "log", "array",
| "failover", "roundrobin"
|
*/
'mailers' => [
'smtp' => [
'transport' => 'smtp',
'scheme' => env('MAIL_SCHEME'),
'url' => env('MAIL_URL'),
'host' => env('MAIL_HOST', '127.0.0.1'),
'port' => env('MAIL_PORT', 2525),
'username' => env('MAIL_USERNAME'),
'password' => env('MAIL_PASSWORD'),
'timeout' => null,
'local_domain' => env('MAIL_EHLO_DOMAIN', parse_url((string) env('APP_URL', 'http://localhost'), PHP_URL_HOST)),
],
'ses' => [
'transport' => 'ses',
],
'postmark' => [
'transport' => 'postmark',
// 'message_stream_id' => env('POSTMARK_MESSAGE_STREAM_ID'),
// 'client' => [
// 'timeout' => 5,
// ],
],
'resend' => [
'transport' => 'resend',
],
'sendmail' => [
'transport' => 'sendmail',
'path' => env('MAIL_SENDMAIL_PATH', '/usr/sbin/sendmail -bs -i'),
],
'log' => [
'transport' => 'log',
'channel' => env('MAIL_LOG_CHANNEL'),
],
'array' => [
'transport' => 'array',
],
'failover' => [
'transport' => 'failover',
'mailers' => [
'smtp',
'log',
],
'retry_after' => 60,
],
'roundrobin' => [
'transport' => 'roundrobin',
'mailers' => [
'ses',
'postmark',
],
'retry_after' => 60,
],
],
/*
|--------------------------------------------------------------------------
| Global "From" Address
|--------------------------------------------------------------------------
|
| You may wish for all emails sent by your application to be sent from
| the same address. Here you may specify a name and address that is
| used globally for all emails that are sent by your application.
|
*/
'from' => [
'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
'name' => env('MAIL_FROM_NAME', env('APP_NAME', 'Laravel')),
],
];

129
config/queue.php Normal file
View File

@@ -0,0 +1,129 @@
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Queue Connection Name
|--------------------------------------------------------------------------
|
| Laravel's queue supports a variety of backends via a single, unified
| API, giving you convenient access to each backend using identical
| syntax for each. The default queue connection is defined below.
|
*/
'default' => env('QUEUE_CONNECTION', 'database'),
/*
|--------------------------------------------------------------------------
| Queue Connections
|--------------------------------------------------------------------------
|
| Here you may configure the connection options for every queue backend
| used by your application. An example configuration is provided for
| each backend supported by Laravel. You're also free to add more.
|
| Drivers: "sync", "database", "beanstalkd", "sqs", "redis",
| "deferred", "background", "failover", "null"
|
*/
'connections' => [
'sync' => [
'driver' => 'sync',
],
'database' => [
'driver' => 'database',
'connection' => env('DB_QUEUE_CONNECTION'),
'table' => env('DB_QUEUE_TABLE', 'jobs'),
'queue' => env('DB_QUEUE', 'default'),
'retry_after' => (int) env('DB_QUEUE_RETRY_AFTER', 90),
'after_commit' => false,
],
'beanstalkd' => [
'driver' => 'beanstalkd',
'host' => env('BEANSTALKD_QUEUE_HOST', 'localhost'),
'queue' => env('BEANSTALKD_QUEUE', 'default'),
'retry_after' => (int) env('BEANSTALKD_QUEUE_RETRY_AFTER', 90),
'block_for' => 0,
'after_commit' => false,
],
'sqs' => [
'driver' => 'sqs',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'prefix' => env('SQS_PREFIX', 'https://sqs.us-east-1.amazonaws.com/your-account-id'),
'queue' => env('SQS_QUEUE', 'default'),
'suffix' => env('SQS_SUFFIX'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'after_commit' => false,
],
'redis' => [
'driver' => 'redis',
'connection' => env('REDIS_QUEUE_CONNECTION', 'default'),
'queue' => env('REDIS_QUEUE', 'default'),
'retry_after' => (int) env('REDIS_QUEUE_RETRY_AFTER', 90),
'block_for' => null,
'after_commit' => false,
],
'deferred' => [
'driver' => 'deferred',
],
'background' => [
'driver' => 'background',
],
'failover' => [
'driver' => 'failover',
'connections' => [
'database',
'deferred',
],
],
],
/*
|--------------------------------------------------------------------------
| Job Batching
|--------------------------------------------------------------------------
|
| The following options configure the database and table that store job
| batching information. These options can be updated to any database
| connection and table which has been defined by your application.
|
*/
'batching' => [
'database' => env('DB_CONNECTION', 'sqlite'),
'table' => 'job_batches',
],
/*
|--------------------------------------------------------------------------
| Failed Queue Jobs
|--------------------------------------------------------------------------
|
| These options configure the behavior of failed queue job logging so you
| can control how and where failed jobs are stored. Laravel ships with
| support for storing failed jobs in a simple file or in a database.
|
| Supported drivers: "database-uuids", "dynamodb", "file", "null"
|
*/
'failed' => [
'driver' => env('QUEUE_FAILED_DRIVER', 'database-uuids'),
'database' => env('DB_CONNECTION', 'sqlite'),
'table' => 'failed_jobs',
],
];

38
config/services.php Normal file
View File

@@ -0,0 +1,38 @@
<?php
return [
/*
|--------------------------------------------------------------------------
| Third Party Services
|--------------------------------------------------------------------------
|
| This file is for storing the credentials for third party services such
| as Mailgun, Postmark, AWS and more. This file provides the de facto
| location for this type of information, allowing packages to have
| a conventional file to locate the various service credentials.
|
*/
'postmark' => [
'key' => env('POSTMARK_API_KEY'),
],
'resend' => [
'key' => env('RESEND_API_KEY'),
],
'ses' => [
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
],
'slack' => [
'notifications' => [
'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
'channel' => env('SLACK_BOT_USER_DEFAULT_CHANNEL'),
],
],
];

217
config/session.php Normal file
View File

@@ -0,0 +1,217 @@
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Session Driver
|--------------------------------------------------------------------------
|
| This option determines the default session driver that is utilized for
| incoming requests. Laravel supports a variety of storage options to
| persist session data. Database storage is a great default choice.
|
| Supported: "file", "cookie", "database", "memcached",
| "redis", "dynamodb", "array"
|
*/
'driver' => env('SESSION_DRIVER', 'database'),
/*
|--------------------------------------------------------------------------
| Session Lifetime
|--------------------------------------------------------------------------
|
| Here you may specify the number of minutes that you wish the session
| to be allowed to remain idle before it expires. If you want them
| to expire immediately when the browser is closed then you may
| indicate that via the expire_on_close configuration option.
|
*/
'lifetime' => (int) env('SESSION_LIFETIME', 120),
'expire_on_close' => env('SESSION_EXPIRE_ON_CLOSE', false),
/*
|--------------------------------------------------------------------------
| Session Encryption
|--------------------------------------------------------------------------
|
| This option allows you to easily specify that all of your session data
| should be encrypted before it's stored. All encryption is performed
| automatically by Laravel and you may use the session like normal.
|
*/
'encrypt' => env('SESSION_ENCRYPT', false),
/*
|--------------------------------------------------------------------------
| Session File Location
|--------------------------------------------------------------------------
|
| When utilizing the "file" session driver, the session files are placed
| on disk. The default storage location is defined here; however, you
| are free to provide another location where they should be stored.
|
*/
'files' => storage_path('framework/sessions'),
/*
|--------------------------------------------------------------------------
| Session Database Connection
|--------------------------------------------------------------------------
|
| When using the "database" or "redis" session drivers, you may specify a
| connection that should be used to manage these sessions. This should
| correspond to a connection in your database configuration options.
|
*/
'connection' => env('SESSION_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Session Database Table
|--------------------------------------------------------------------------
|
| When using the "database" session driver, you may specify the table to
| be used to store sessions. Of course, a sensible default is defined
| for you; however, you're welcome to change this to another table.
|
*/
'table' => env('SESSION_TABLE', 'sessions'),
/*
|--------------------------------------------------------------------------
| Session Cache Store
|--------------------------------------------------------------------------
|
| When using one of the framework's cache driven session backends, you may
| define the cache store which should be used to store the session data
| between requests. This must match one of your defined cache stores.
|
| Affects: "dynamodb", "memcached", "redis"
|
*/
'store' => env('SESSION_STORE'),
/*
|--------------------------------------------------------------------------
| Session Sweeping Lottery
|--------------------------------------------------------------------------
|
| Some session drivers must manually sweep their storage location to get
| rid of old sessions from storage. Here are the chances that it will
| happen on a given request. By default, the odds are 2 out of 100.
|
*/
'lottery' => [2, 100],
/*
|--------------------------------------------------------------------------
| Session Cookie Name
|--------------------------------------------------------------------------
|
| Here you may change the name of the session cookie that is created by
| the framework. Typically, you should not need to change this value
| since doing so does not grant a meaningful security improvement.
|
*/
'cookie' => env(
'SESSION_COOKIE',
Str::slug((string) env('APP_NAME', 'laravel')).'-session'
),
/*
|--------------------------------------------------------------------------
| Session Cookie Path
|--------------------------------------------------------------------------
|
| The session cookie path determines the path for which the cookie will
| be regarded as available. Typically, this will be the root path of
| your application, but you're free to change this when necessary.
|
*/
'path' => env('SESSION_PATH', '/'),
/*
|--------------------------------------------------------------------------
| Session Cookie Domain
|--------------------------------------------------------------------------
|
| This value determines the domain and subdomains the session cookie is
| available to. By default, the cookie will be available to the root
| domain without subdomains. Typically, this shouldn't be changed.
|
*/
'domain' => env('SESSION_DOMAIN'),
/*
|--------------------------------------------------------------------------
| HTTPS Only Cookies
|--------------------------------------------------------------------------
|
| By setting this option to true, session cookies will only be sent back
| to the server if the browser has a HTTPS connection. This will keep
| the cookie from being sent to you when it can't be done securely.
|
*/
'secure' => env('SESSION_SECURE_COOKIE'),
/*
|--------------------------------------------------------------------------
| HTTP Access Only
|--------------------------------------------------------------------------
|
| Setting this value to true will prevent JavaScript from accessing the
| value of the cookie and the cookie will only be accessible through
| the HTTP protocol. It's unlikely you should disable this option.
|
*/
'http_only' => env('SESSION_HTTP_ONLY', true),
/*
|--------------------------------------------------------------------------
| Same-Site Cookies
|--------------------------------------------------------------------------
|
| This option determines how your cookies behave when cross-site requests
| take place, and can be used to mitigate CSRF attacks. By default, we
| will set this value to "lax" to permit secure cross-site requests.
|
| See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value
|
| Supported: "lax", "strict", "none", null
|
*/
'same_site' => env('SESSION_SAME_SITE', 'lax'),
/*
|--------------------------------------------------------------------------
| Partitioned Cookies
|--------------------------------------------------------------------------
|
| Setting this value to true will tie the cookie to the top-level site for
| a cross-site context. Partitioned cookies are accepted by the browser
| when flagged "secure" and the Same-Site attribute is set to "none".
|
*/
'partitioned' => env('SESSION_PARTITIONED_COOKIE', false),
];

1
database/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
*.sqlite*

View File

@@ -0,0 +1,45 @@
<?php
namespace Database\Factories;
use App\Models\User;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;
/**
* @extends Factory<User>
*/
class UserFactory extends Factory
{
/**
* The current password being used by the factory.
*/
protected static ?string $password;
/**
* Define the model's default state.
*
* @return array<string, mixed>
*/
public function definition(): array
{
return [
'name' => fake()->name(),
'email' => fake()->unique()->safeEmail(),
'email_verified_at' => now(),
'password' => static::$password ??= Hash::make('password'),
'remember_token' => Str::random(10),
];
}
/**
* Indicate that the model's email address should be unverified.
*/
public function unverified(): static
{
return $this->state(fn (array $attributes) => [
'email_verified_at' => null,
]);
}
}

View File

@@ -0,0 +1,49 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('users', function (Blueprint $table) {
$table->id();
$table->string('name');
$table->string('email')->unique();
$table->timestamp('email_verified_at')->nullable();
$table->string('password');
$table->rememberToken();
$table->timestamps();
});
Schema::create('password_reset_tokens', function (Blueprint $table) {
$table->string('email')->primary();
$table->string('token');
$table->timestamp('created_at')->nullable();
});
Schema::create('sessions', function (Blueprint $table) {
$table->string('id')->primary();
$table->foreignId('user_id')->nullable()->index();
$table->string('ip_address', 45)->nullable();
$table->text('user_agent')->nullable();
$table->longText('payload');
$table->integer('last_activity')->index();
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('users');
Schema::dropIfExists('password_reset_tokens');
Schema::dropIfExists('sessions');
}
};

View File

@@ -0,0 +1,35 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('cache', function (Blueprint $table) {
$table->string('key')->primary();
$table->mediumText('value');
$table->integer('expiration')->index();
});
Schema::create('cache_locks', function (Blueprint $table) {
$table->string('key')->primary();
$table->string('owner');
$table->integer('expiration')->index();
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('cache');
Schema::dropIfExists('cache_locks');
}
};

View File

@@ -0,0 +1,57 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('jobs', function (Blueprint $table) {
$table->id();
$table->string('queue')->index();
$table->longText('payload');
$table->unsignedTinyInteger('attempts');
$table->unsignedInteger('reserved_at')->nullable();
$table->unsignedInteger('available_at');
$table->unsignedInteger('created_at');
});
Schema::create('job_batches', function (Blueprint $table) {
$table->string('id')->primary();
$table->string('name');
$table->integer('total_jobs');
$table->integer('pending_jobs');
$table->integer('failed_jobs');
$table->longText('failed_job_ids');
$table->mediumText('options')->nullable();
$table->integer('cancelled_at')->nullable();
$table->integer('created_at');
$table->integer('finished_at')->nullable();
});
Schema::create('failed_jobs', function (Blueprint $table) {
$table->id();
$table->string('uuid')->unique();
$table->text('connection');
$table->text('queue');
$table->longText('payload');
$table->longText('exception');
$table->timestamp('failed_at')->useCurrent();
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('jobs');
Schema::dropIfExists('job_batches');
Schema::dropIfExists('failed_jobs');
}
};

View File

@@ -0,0 +1,32 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('categories', function (Blueprint $table): void {
$table->id();
$table->string('name');
$table->string('slug')->unique();
$table->text('description')->nullable();
$table->timestamps();
$table->index('name');
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('categories');
}
};

View File

@@ -0,0 +1,44 @@
<?php
use App\Models\Post;
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::create('posts', function (Blueprint $table): void {
$table->id();
$table->string('title');
$table->string('slug')->unique();
$table->longText('content');
$table->text('excerpt')->nullable();
$table->foreignId('category_id')->constrained()->restrictOnDelete();
$table->string('featured_image')->nullable();
$table->boolean('is_featured')->default(false);
$table->enum('status', [Post::STATUS_DRAFT, Post::STATUS_PUBLISHED])->default(Post::STATUS_DRAFT);
$table->timestamp('published_at')->nullable();
$table->timestamps();
$table->index('title');
$table->index('category_id');
$table->index('is_featured');
$table->index('status');
$table->index('published_at');
$table->index(['status', 'published_at']);
});
}
/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::dropIfExists('posts');
}
};

View File

@@ -0,0 +1,25 @@
<?php
namespace Database\Seeders;
use App\Models\User;
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;
class DatabaseSeeder extends Seeder
{
use WithoutModelEvents;
/**
* Seed the application's database.
*/
public function run(): void
{
// User::factory(10)->create();
User::factory()->create([
'name' => 'Test User',
'email' => 'test@example.com',
]);
}
}

17
package.json Normal file
View File

@@ -0,0 +1,17 @@
{
"$schema": "https://www.schemastore.org/package.json",
"private": true,
"type": "module",
"scripts": {
"build": "vite build",
"dev": "vite"
},
"devDependencies": {
"@tailwindcss/vite": "^4.0.0",
"axios": "^1.11.0",
"concurrently": "^9.0.1",
"laravel-vite-plugin": "^2.0.0",
"tailwindcss": "^4.0.0",
"vite": "^7.0.7"
}
}

36
phpunit.xml Normal file
View File

@@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="vendor/autoload.php"
colors="true"
>
<testsuites>
<testsuite name="Unit">
<directory>tests/Unit</directory>
</testsuite>
<testsuite name="Feature">
<directory>tests/Feature</directory>
</testsuite>
</testsuites>
<source>
<include>
<directory>app</directory>
</include>
</source>
<php>
<env name="APP_ENV" value="testing"/>
<env name="APP_MAINTENANCE_DRIVER" value="file"/>
<env name="BCRYPT_ROUNDS" value="4"/>
<env name="BROADCAST_CONNECTION" value="null"/>
<env name="CACHE_STORE" value="array"/>
<env name="DB_CONNECTION" value="sqlite"/>
<env name="DB_DATABASE" value=":memory:"/>
<env name="DB_URL" value=""/>
<env name="MAIL_MAILER" value="array"/>
<env name="QUEUE_CONNECTION" value="sync"/>
<env name="SESSION_DRIVER" value="array"/>
<env name="PULSE_ENABLED" value="false"/>
<env name="TELESCOPE_ENABLED" value="false"/>
<env name="NIGHTWATCH_ENABLED" value="false"/>
</php>
</phpunit>

25
public/.htaccess Normal file
View File

@@ -0,0 +1,25 @@
<IfModule mod_rewrite.c>
<IfModule mod_negotiation.c>
Options -MultiViews -Indexes
</IfModule>
RewriteEngine On
# Handle Authorization Header
RewriteCond %{HTTP:Authorization} .
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
# Handle X-XSRF-Token Header
RewriteCond %{HTTP:x-xsrf-token} .
RewriteRule .* - [E=HTTP_X_XSRF_TOKEN:%{HTTP:X-XSRF-Token}]
# Redirect Trailing Slashes If Not A Folder...
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_URI} (.+)/$
RewriteRule ^ %1 [L,R=301]
# Send Requests To Front Controller...
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.php [L]
</IfModule>

0
public/favicon.ico Normal file
View File

20
public/index.php Normal file
View File

@@ -0,0 +1,20 @@
<?php
use Illuminate\Foundation\Application;
use Illuminate\Http\Request;
define('LARAVEL_START', microtime(true));
// Determine if the application is in maintenance mode...
if (file_exists($maintenance = __DIR__.'/../storage/framework/maintenance.php')) {
require $maintenance;
}
// Register the Composer autoloader...
require __DIR__.'/../vendor/autoload.php';
// Bootstrap Laravel and handle the request...
/** @var Application $app */
$app = require_once __DIR__.'/../bootstrap/app.php';
$app->handleRequest(Request::capture());

2
public/robots.txt Normal file
View File

@@ -0,0 +1,2 @@
User-agent: *
Disallow:

11
resources/css/app.css Normal file
View File

@@ -0,0 +1,11 @@
@import 'tailwindcss';
@source '../../vendor/laravel/framework/src/Illuminate/Pagination/resources/views/*.blade.php';
@source '../../storage/framework/views/*.php';
@source '../**/*.blade.php';
@source '../**/*.js';
@theme {
--font-sans: 'Instrument Sans', ui-sans-serif, system-ui, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji',
'Segoe UI Symbol', 'Noto Color Emoji';
}

1
resources/js/app.js Normal file
View File

@@ -0,0 +1 @@
import './bootstrap';

4
resources/js/bootstrap.js vendored Normal file
View File

@@ -0,0 +1,4 @@
import axios from 'axios';
window.axios = axios;
window.axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';

View File

@@ -0,0 +1,128 @@
<!DOCTYPE html>
<html lang="pt-BR">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{{ $serviceName }} - Dashboard</title>
<style>
:root {
color-scheme: light dark;
--bg: #0f172a;
--card: #111827;
--text: #e5e7eb;
--muted: #94a3b8;
--accent: #38bdf8;
--border: #1f2937;
}
* { box-sizing: border-box; }
body {
margin: 0;
font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
background: radial-gradient(circle at top left, #1e3a8a 0, var(--bg) 40%);
color: var(--text);
}
main {
width: min(1120px, calc(100% - 32px));
margin: 48px auto;
}
.hero {
padding: 32px;
border: 1px solid var(--border);
border-radius: 24px;
background: rgba(17, 24, 39, 0.88);
box-shadow: 0 24px 80px rgba(0, 0, 0, 0.35);
}
h1 {
margin: 0 0 12px;
font-size: clamp(2rem, 5vw, 3.5rem);
letter-spacing: -0.04em;
}
p {
margin: 0;
color: var(--muted);
line-height: 1.7;
}
table {
width: 100%;
margin-top: 28px;
border-collapse: collapse;
overflow: hidden;
border-radius: 18px;
background: rgba(15, 23, 42, 0.72);
}
th, td {
padding: 16px;
text-align: left;
border-bottom: 1px solid var(--border);
vertical-align: top;
}
th {
color: #bfdbfe;
font-size: 0.82rem;
text-transform: uppercase;
letter-spacing: 0.08em;
background: rgba(30, 41, 59, 0.92);
}
code {
color: var(--accent);
white-space: nowrap;
}
.badge {
display: inline-flex;
padding: 4px 10px;
border: 1px solid rgba(56, 189, 248, 0.4);
border-radius: 999px;
color: #bae6fd;
background: rgba(14, 165, 233, 0.12);
font-size: 0.82rem;
}
@media (max-width: 760px) {
table, thead, tbody, th, td, tr { display: block; }
thead { display: none; }
tr { border-bottom: 1px solid var(--border); }
td { border-bottom: none; }
td::before {
content: attr(data-label);
display: block;
margin-bottom: 6px;
color: #bfdbfe;
font-size: 0.75rem;
text-transform: uppercase;
letter-spacing: 0.08em;
}
}
</style>
</head>
<body>
<main>
<section class="hero">
<h1>{{ $serviceName }}</h1>
<p>
Microserviço de Blog/Notícias em Laravel, com CRUD de posts e categorias,
filtros, paginação, health checks e estrutura preparada para autenticação JWT.
</p>
<table>
<thead>
<tr>
<th>Método</th>
<th>Rota</th>
<th>Descrição</th>
<th>Acesso</th>
</tr>
</thead>
<tbody>
@foreach ($routes as $route)
<tr>
<td data-label="Método"><span class="badge">{{ $route['method'] }}</span></td>
<td data-label="Rota"><code>{{ $route['uri'] }}</code></td>
<td data-label="Descrição">{{ $route['description'] }}</td>
<td data-label="Acesso">{{ $route['visibility'] }}</td>
</tr>
@endforeach
</tbody>
</table>
</section>
</main>
</body>
</html>

File diff suppressed because one or more lines are too long

73
routes/api.php Normal file
View File

@@ -0,0 +1,73 @@
<?php
use App\Http\Controllers\Api\CategoryController;
use App\Http\Controllers\Api\PostController;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Route;
Route::prefix('v1')->group(function (): void {
/**
* Health check endpoint.
*
* @group Health
*/
Route::get('/health', function () {
return response()->json([
'service' => config('app.name', 'blog-api'),
'status' => 'ok',
'timestamp' => now()->toISOString(),
]);
})->name('api.v1.health');
/**
* Database health check endpoint.
*
* @group Health
*/
Route::get('/health-check-db', function () {
try {
DB::select('select 1');
return response()->json([
'service' => config('app.name', 'blog-api'),
'database' => 'connected',
'timestamp' => now()->toISOString(),
]);
} catch (Throwable $throwable) {
report($throwable);
return response()->json([
'service' => config('app.name', 'blog-api'),
'database' => 'disconnected',
'message' => 'Não foi possível conectar ao banco de dados.',
'timestamp' => now()->toISOString(),
], 500);
}
})->name('api.v1.health.db');
Route::prefix('public')->name('api.v1.public.')->group(function (): void {
Route::get('/posts', [PostController::class, 'index'])->name('posts.index');
Route::get('/posts/{post:slug}', [PostController::class, 'show'])->name('posts.show');
Route::get('/categories', [CategoryController::class, 'index'])->name('categories.index');
Route::get('/categories/{category:slug}', [CategoryController::class, 'show'])->name('categories.show');
});
/**
* Protected routes placeholder.
*
* These routes are intentionally grouped to make future JWT integration straightforward:
* Route::middleware(['auth:api'])->group(...)
*/
Route::prefix('admin')
->name('api.v1.admin.')
// ->middleware('auth:api')
->group(function (): void {
Route::apiResource('posts', PostController::class)->parameters([
'posts' => 'post',
]);
Route::apiResource('categories', CategoryController::class)->parameters([
'categories' => 'category',
]);
});
});

8
routes/console.php Normal file
View File

@@ -0,0 +1,8 @@
<?php
use Illuminate\Foundation\Inspiring;
use Illuminate\Support\Facades\Artisan;
Artisan::command('inspire', function () {
$this->comment(Inspiring::quote());
})->purpose('Display an inspiring quote');

61
routes/web.php Normal file
View File

@@ -0,0 +1,61 @@
<?php
use Illuminate\Support\Facades\Route;
Route::get('/', function () {
$routes = [
[
'method' => 'GET',
'uri' => '/api/v1/health',
'description' => 'Verifica se o serviço está respondendo.',
'visibility' => 'Pública',
],
[
'method' => 'GET',
'uri' => '/api/v1/health-check-db',
'description' => 'Verifica a conexão com o banco de dados.',
'visibility' => 'Pública',
],
[
'method' => 'GET',
'uri' => '/api/v1/public/posts',
'description' => 'Lista posts com paginação, busca e filtros.',
'visibility' => 'Pública',
],
[
'method' => 'GET',
'uri' => '/api/v1/public/posts/{slug}',
'description' => 'Exibe um post pelo slug.',
'visibility' => 'Pública',
],
[
'method' => 'GET',
'uri' => '/api/v1/public/categories',
'description' => 'Lista categorias com contagem de posts.',
'visibility' => 'Pública',
],
[
'method' => 'GET',
'uri' => '/api/v1/public/categories/{slug}',
'description' => 'Exibe uma categoria pelo slug.',
'visibility' => 'Pública',
],
[
'method' => 'API RESOURCE',
'uri' => '/api/v1/admin/posts',
'description' => 'CRUD administrativo de posts. Grupo preparado para JWT.',
'visibility' => 'Protegida em breve',
],
[
'method' => 'API RESOURCE',
'uri' => '/api/v1/admin/categories',
'description' => 'CRUD administrativo de categorias. Grupo preparado para JWT.',
'visibility' => 'Protegida em breve',
],
];
return view('api-dashboard', [
'serviceName' => config('app.name', 'Blog API'),
'routes' => $routes,
]);
});

4
storage/app/.gitignore vendored Normal file
View File

@@ -0,0 +1,4 @@
*
!private/
!public/
!.gitignore

2
storage/app/private/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

2
storage/app/public/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

9
storage/framework/.gitignore vendored Normal file
View File

@@ -0,0 +1,9 @@
compiled.php
config.php
down
events.scanned.php
maintenance.php
routes.php
routes.scanned.php
schedule-*
services.json

3
storage/framework/cache/.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
*
!data/
!.gitignore

View File

@@ -0,0 +1,2 @@
*
!.gitignore

2
storage/framework/sessions/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

2
storage/framework/testing/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

2
storage/framework/views/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

2
storage/logs/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore

View File

@@ -0,0 +1,19 @@
<?php
namespace Tests\Feature;
// use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_the_application_returns_a_successful_response(): void
{
$response = $this->get('/');
$response->assertStatus(200);
}
}

10
tests/TestCase.php Normal file
View File

@@ -0,0 +1,10 @@
<?php
namespace Tests;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
abstract class TestCase extends BaseTestCase
{
//
}

View File

@@ -0,0 +1,16 @@
<?php
namespace Tests\Unit;
use PHPUnit\Framework\TestCase;
class ExampleTest extends TestCase
{
/**
* A basic test example.
*/
public function test_that_true_is_true(): void
{
$this->assertTrue(true);
}
}

18
vite.config.js Normal file
View File

@@ -0,0 +1,18 @@
import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';
import tailwindcss from '@tailwindcss/vite';
export default defineConfig({
plugins: [
laravel({
input: ['resources/css/app.css', 'resources/js/app.js'],
refresh: true,
}),
tailwindcss(),
],
server: {
watch: {
ignored: ['**/storage/framework/views/**'],
},
},
});