hnqca / apirest-mvc-crud-php

Simples API REST desenvolvida à fim de aprender conceitos relacionados à webservice na linguagem PHP.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Simples API REST desenvolvida à fim de aprender conceitos relacionados à webservice na linguagem PHP.
Foi utilizado durante o desenvolvimento: Orientação à objetos juntamente com o padrão de arquitetura MVC.

 


Objetivo da API:

Realizar o gerenciamento de usuários (CRUD) cadastrar, ler, atualizar e deletar registros no banco de dados MySQL.

Utilização:

Defina a conexão com o banco de dados através do arquivo ".env" que está localizado no diretório raiz do projeto.

Crie um banco de dados chamado "apirest" e importe o arquivo "users.sql" que também está no diretório raiz.


📖 Dependências utilizadas:

Execute o comando composer install para instalar todas as dependências utilizadas neste projeto.

Nome Versão
vlucas/phpdotenv ^5.5
coffeecode/router ^2.0

📖 Authorization Bearer:

Para consumir a API, é necessário enviar o Authorization Bearer no cabeçalho da requisição. Foi criado dois tokens JWT, onde cada token contém diferentes níveis de acessos.

Acesso Token
1 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3MiOjF9.F23gElIWUCdtlytwQrLzURNnmv+QSn5G0eoVg+rWfos=
2 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3MiOjJ9.ZCByDaVvbbFb5TJn91Itbcp6CogMEPpMJWq7QiZvMAo=

Endpoints (6):

https://example.com/ endpoint

Endpoint Acesso Método Descrição
/users/{id} >= 1 GET Obtém os detalhes de um usuário específico com base no seu ID
/users >= 1 GET Obtém a lista de todos os usuários cadastrados
/users/limit/{limit} >= 1 GET Especifica a quantidade máxima de registros a serem listados
/users >= 2 POST Cria um novo usuário
/users/{id} >= 2 PUT Atualiza as informações de um usuário com base no seu ID
/users/{id} >= 2 DELETE Remove um usuário específico com base no seu ID

Características e tecnologias:

  • PHP 8.X
  • Modelo REST
  • Orientação à Objetos (POO)
  • ACL
  • MVC
  • JSON
  • JWT
  • Composer
  • PSR-4
  • PDO
  • MySQL
  • Bearer Authorization
  • Métodos GET, PUT, POST e DELETE

About

Simples API REST desenvolvida à fim de aprender conceitos relacionados à webservice na linguagem PHP.


Languages

Language:PHP 100.0%