Recommend this page to a friend! |
Download |
Info | Example | Files | Install with Composer | Download | Reputation | Support forum | Blog | Links |
Last Updated | Ratings | Unique User Downloads | Download Rankings | |||||
2024-04-19 (5 months ago) | Not enough user ratings | Total: 122 | All time: 9,480 This week: 47 |
Version | License | PHP version | Categories | |||
crud-rest 1.0.0 | MIT/X Consortium ... | 5 | PHP 5, Databases, Web services, Desig... |
Description | Author | |
This package implements an example REST API using MVC. |
<?php |
Este projeto serve como um modelo inicial para a implementação de um sistema CRUD (Create, Read, Update, Delete) básico, utilizando PHP para fins educacionais. É projetado para ensinar os fundamentos da construção de uma aplicação CRUD seguindo boas práticas de programação e padrões de projeto.
O projeto segue o padrão MVC (Model-View-Controller), que separa a aplicação em três componentes principais para organizar a lógica de negócios, a interface do usuário e a interação do usuário. Isso promove uma separação clara de preocupações, facilitando a manutenção e expansão do código.
Utilizamos uma arquitetura baseada em serviços, onde o backend pode ser consumido por diferentes clientes (como uma aplicação web front-end ou mobile) através de uma API RESTful.
A comunicação entre o cliente e o servidor é feita através de HTTP, seguindo os princípios REST. Isso permite uma comunicação stateless, utilizando os métodos HTTP (GET, POST, PUT, DELETE) para realizar operações CRUD.
A persistência de dados é realizada utilizando o SQLite, o que torna este projeto modelo inicial fácil de configurar e executar sem a necessidade de um ambiente de banco de dados complexo. Entretanto, a abstração da camada de banco de dados através do uso do padrão Repository permite a fácil substituição por outros SGBDs (Sistemas Gerenciadores de Banco de Dados), como MySQL, PostgreSQL, entre outros. Isso é alcançado ajustando apenas a configuração de conexão, demonstrando a flexibilidade do projeto em se adaptar a diferentes ambientes de banco de dados.
Este projeto utiliza Composer para gerenciar suas dependências. Assim, é necessário ter o Composer instalado no seu sistema para configurar o ambiente de desenvolvimento.
Após clonar o repositório para a sua máquina local, navegue até o diretório do projeto abre o promp de comando e execute o seguinte comando para instalar as dependências necessárias:
composer install
Para desenvolvedores que têm o PHP instalado independentemente:
Se você tem o PHP instalado em seu sistema, pode iniciar o servidor embutido do PHP com o seguinte comando:
php -S localhost:8000
Se preferir usar o XAMPP, coloque o projeto na pasta htdocs do XAMPP e inicie o Apache através do painel de controle do XAMPP. Então, você poderá acessar o projeto via navegador com uma URL baseada no nome da pasta dentro de htdocs.
Esta API fornece um conjunto de endpoints para operações CRUD (Create, Read, Update, Delete) para usuários. Abaixo estão os detalhes de como interagir com cada endpoint.
Base URL Supondo que o servidor esteja executando localmente na porta 8000, a URL base será: http://localhost:8000/
URL: /login?action=login Método: POST Dados Requeridos:
{
"email": "user@example.com",
"senha": "password123"
}
Descrição: Autentica um usuário com email e senha.
URL: / Método: POST Dados Requeridos:
{
"nome": "Novo Usuario",
"email": "novo@example.com",
"senha": "novaSenha123"
}
Descrição: Cria um novo usuário com nome, email e senha.
Para um único usuário: URL: /?id=1 Método: GET Descrição: Obtém as informações de um usuário específico pelo ID.
URL: / Método: GET Descrição: Lista todos os usuários.
Atualizar Usuário URL: / Método: PUT Dados Requeridos:
{
"usuario_id": 1,
"nome": "Usuario Atualizado",
"email": "atualizado@example.com",
"senha": "senhaAtualizada123"
}
Descrição: Atualiza as informações de um usuário existente.
URL: /?id=1 Método: DELETE Descrição: Exclui um usuário específico pelo ID.
Para testar esses endpoints com o Postman:
Abra o Postman e crie uma nova requisição. 2. Selecione o método apropriado (GET, POST, PUT, DELETE) conforme a operação que deseja testar.
Insira a URL base seguida pelo caminho do endpoint. Por exemplo, para criar um novo usuário, a URL seria http://localhost:8000/ com o método POST. Para os métodos que requerem dados (POST e PUT), vá até a aba "Body", selecione "raw" e escolha "JSON" como formato. Então, insira os dados requeridos no formato JSON. Pressione o botão "Send" para realizar a requisição.
Especifique a licença sob a qual o projeto é disponibilizado, promovendo o uso e contribuição da comunidade.
Files (10) |
File | Role | Description | ||
---|---|---|---|---|
app (6 directories) | ||||
composer.json | Data | Auxiliary data | ||
readme.md | Doc. | Documentation |
Files (10) | / | app |
File | Role | Description | ||
---|---|---|---|---|
Controller (1 file) | ||||
Database (3 files) | ||||
Http (1 file) | ||||
Model (1 file) | ||||
Repository (1 file) | ||||
Router (1 file) |
Files (10) | / | app | / | Database |
File | Role | Description |
---|---|---|
agenda.sqbpro | Data | Auxiliary data |
config.php | Aux. | Auxiliary script |
Database.php | Class | Class source |
The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page. |
Install with Composer |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.