FastBackPHP é uma automação simplificada para conectar-se a um banco de dados existente e abstrair todas as tabelas em modelos (models), controladores (controllers) e repositórios (repositories). Inspirado em ferramentas como PHPMaker, Scriptcase, e Laravel Nova, este micro-framework foi projetado para facilitar a criação de APIs REST com suporte a um sistema de rotas integrado.
FastBackPHP foi criado para desenvolvedores que desejam automatizar a construção de APIs REST para aplicações que já possuem um banco de dados estruturado. A ferramenta abstrai a lógica básica e permite que você se concentre em customizar a lógica de negócios ou nos endpoints necessários.
- Automação de APIs REST: Ideal para gerar rapidamente endpoints básicos para CRUD.
- Prototipagem Rápida: Geração inicial de código para novos projetos baseados em bancos de dados existentes.
- Integração com Sistemas Legados: Perfeito para integrar APIs a sistemas que já possuem um banco de dados definido.
- Educação: Excelente para aprendizado e demonstração de como APIs REST funcionam com abstração de camadas (Model, Controller e Repository).
-
Configuração de Banco de Dados
- Suporte a bancos MySQL, SQLite, PostgreSQL, SQL Server e MongoDB.
- Configuração via terminal para gerar automaticamente os parâmetros no arquivo
Config.
-
Geração de Código
- Models: Representações das tabelas do banco de dados.
- Repositories: Classes para encapsular operações de banco de dados (CRUD).
- Controllers: Camada para lidar com rotas e integração entre Models e Repositories.
-
Sistema de Rotas
- Inspirado em frameworks como Laravel e Symfony, suporta anotações para simplificar o roteamento.
-
Flexibilidade
- Não restringe a ordem de uso dos comandos.
- Você pode gerar apenas Models ou Repositories separadamente.
- PHP 8.0+
- Composer instalado
- Servidor Web (ex.: Apache, Nginx, ou CLI do PHP)
-
Clone o repositório ou baixe os arquivos:
git clone https://github.com/faustinopsy/PHPCrudMVC-v7
-
Instale as dependências via Composer:
composer install
-
Execute o CLI (Terminal/Promp):
php Fast.php
-
Siga as instruções no terminal:
- Opção 1: Configure o banco de dados. Esse passo é obrigatório para outros comandos.
- Opção 2: Gere as Models para abstrair tabelas do banco.
- Opção 3: Gere os Repositories para operações CRUD.
- Opção 4: Gere os Controllers para criar endpoints REST (esse passo deve vir depois dos dois anteriores), pois o controller ler os métodos do repository e gera as rotas para cada método. Opção 5: SObre o servidor interno do CLI.
Ao executar php Fast.php, você verá as seguintes opções no terminal:
-
Configurar Banco de Dados:
- Defina as credenciais do banco no arquivo
Configpara conexão e geração de código.
- Defina as credenciais do banco no arquivo
-
Gerar Models:
- Gera classes que representam as tabelas do banco de dados.
-
Gerar Repositories:
- Cria classes para manipulação de dados no banco com métodos CRUD.
-
Gerar Controllers:
- Cria classes que conectam Models e Repositories, prontos para uso como APIs REST.
-
Subir o servidor embutido:
- Servidor do PHP.
-
Sair:
- Finaliza o CLI.
- Passo 1: Configuração do banco de dados é obrigatória antes de executar qualquer outro comando. (Pois esse framework é para possiveis migrações, ode já existem um banco de dados com tabelas)
- Uso flexível: Pode-se gerar apenas Models ou Repositories, conforme necessário.
- Controllers dependem de Models e Repositories: Não é possível gerar Controllers sem que Models e Repositories existam.
O FastBackPHP utiliza Attributes (um recurso do PHP 8+) para um roteamento declarativo e limpo, inspirado em frameworks modernos. Em vez de um arquivo de rotas gigante, cada rota é definida diretamente acima do método do controller que ela executa.
Quando você gera os controllers, a ferramenta inspeciona os métodos públicos da classe de repositório correspondente e cria um método no controller para cada um, adicionando um atributo #[Router(...)] acima dele.
Exemplo de um UsersController.php gerado:
<?php
namespace Fast\Back\Controllers;
use Fast\Back\Repositories\UsersRepository;
use Fast\Back\Rotas\Router;
class UsersController
{
private $repository;
public function __construct() {
$this->repository = new UsersRepository();
}
// Rota para buscar todos os usuários
#[Router('/users', methods: ['GET'])]
public function findAll() {
// ...
}
// Rota para buscar um usuário específico pelo ID
#[Router('/users/{id}', methods: ['GET'])]
public function findById($id) {
// ...
}
// Rota para criar um novo usuário
#[Router('/users', methods: ['POST'])]
public function create($data) {
// ...
}
}
#[Router(...)]: É o atributo que define o endpoint.
'/users/{id}': É o caminho (path) da rota. Partes entre chaves, como {id}, são parâmetros dinâmicos que são passados para o método.
methods: ['GET']: É o verbo HTTP permitido para esta rota.
O framework lê esses atributos automaticamente e direciona as requisições para o método correto.
Após gerar o código e iniciar o servidor (php Fast.php > opção 5), você pode usar qualquer cliente HTTP (como Postman, Insomnia, ou o bom e velho curl) para interagir com seus novos endpoints.
Listar todos os usuários (GET)
curl -X GET http://localhost/usersBuscar o usuário com ID 1 (GET com parâmetro)
curl -X GET http://localhost/users/1Criar um novo usuário (POST com corpo JSON)
curl -X POST \
http://localhost:8080/users \
-H 'Content-Type: application/json' \
-d '{
"email": "[email protected]",
"password_hash": "um_hash_de_senha_muito_seguro"
}'Contribuições são bem-vindas! Caso tenha sugestões ou encontre bugs, abra uma issue ou envie um pull request no repositório oficial.
Se por algum motivo esse pacote é útil, deixe uma doação para eu melhorar isso colocando outra camada que leverá muito temp ode desenvolvimento, mas a outra camada é um frontend para cada controller, com autenticação e autorização.
FastBackPHP é distribuído sob a licença MIT. Veja o arquivo LICENSE para mais informações.