laravel api

Projeto de back-end Laravel/PHP

Link para construção de produção ao vivo

Bem-vindo a mais um dos meus projetos de API. Para este projeto, escrevi, testei e implantei um aplicativo Laravel como parte de um projeto full-stack, aproveitando muitos dos recursos poderosos do framework, incluindo:

• fachadas e funções auxiliares;
• autenticação e autorização de usuário;
• propagação de banco de dados;
• Construtor de consultas ORM Eloquent;
• ferramentas avançadas de teste de API.

Para que serve?

Esta API processa dados relacionados aos usuários/candidatos e seus exames. Por exemplo, ele permite que um usuário visualize informações sobre locais/locais de exames, datas, nomes de candidatos e assim por diante.

Uma observação importante sobre o acesso

• Certifique-se de incluir um cabeçalho HTTP Accept: application/json em todas as solicitações à API.
• A maioria dos recursos da API está disponível apenas para usuários de nível administrativo. Para experimentar este aplicativo, você pode se inscrever para uma nova conta usando um e-mail que termina com @v3.admin , que lhe dará privilégios totais de administrador.

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

Depois de se inscrever ou fazer login, você receberá um token de API que precisará ser anexado aos cabeçalhos de sua solicitação para garantir acesso total ao CRUD.

Pontos de extremidade disponíveis

Para acessar cada endpint, anexe o fragmento de URI ao endoint raiz. Você pode ver mais detalhes visitando o endpoint raiz.

Recurso	Descrição	Autenticação/autorização
POSTAR/inscrever-se	Crie uma nova conta.	Público
POSTAR/login	Faça login na conta existente.	Público
GET /logout/{id}	Efetue logout (revoga tokens).	Somente usuários logados
OBTER / exames	Mostra lista de todos os exames. Inclui 5 parâmetros de consulta opcionais .	Somente administrador
OBTER /exames/{id}	Faça exame específico.	Só é possível ver os próprios exames
COLOQUE /exames/{id}	Modifique um exame específico.	Só é possível editar os próprios exames
GET /exames/pesquisa/{nome}	Pesquisa de substring para candidato específico.	Somente administrador
EXCLUIR /exames/{id}	Excluir exame.	Só é possível excluir o próprio exame
OBTER /usuários	Obtenha a lista de todos os usuários.	Somente administrador
GET /usuários/{id}/exames	Obtenha uma lista de todos os exames de um usuário	Só é possível ver os próprios exames

Principais recursos do produto

• Implantado no Vercel como uma 'Função Serverless', utilizando um runtime PHP para lidar com a configuração das aplicações.
• A implantação de produção está vinculada a um banco de dados PSQL ativo hospedado remotamente com um provedor diferente.
• Sintaxe expressiva específica do Laravel com extenso encadeamento de métodos, permitindo uma estrutura de código mais concisa.
• Desenvolvido de maneira orientada a testes usando PHPUnit e a sintaxe JSON fluente do Laravel (baseada em encerramentos e na classe AssertableJson).
• Testes automatizados com um fluxo de trabalho de CI/CD configurado usando Github Actions.
• Arquitetado usando um padrão MVC orientado a objetos
• Serviços de autenticação implementados usando Sanctum
  • Os usuários podem se inscrever e fazer login.
  • As rotas protegidas só são acessíveis a usuários com tokens de API válidos.
• Serviços de autorização implementados usando portas do Laravel, uma abordagem de autorização baseada em fechamento.
  • Certas ações são permitidas apenas para usuários com funções específicas, como status de administrador.
• Relacionamentos e restrições de esquema definidos usando as ferramentas de relacionamento do Eloquent ORM
• Banco de dados SQLite usado para desenvolvimento e teste.

Principais arquivos e pastas no diretório do projeto

• ./app contém a lógica central do aplicativo.
  • /app/Http/Controllers contém a lógica de manipulação de solicitações.
  • app/Models contém todas as classes do modelo e é onde especificamos todos os campos preenchíveis.
  • app/Providers contém classes que inicializam todo o aplicativo.
• ./routes/api.php é onde definimos concisamente todas as nossas rotas (endpoints).
• ./tests/Feature contém todos os testes de integração do aplicativo.
• ./config/database.php permite que você defina as configurações de conexão do banco de dados.
• ./database é outra pasta muito importante.
  • ./database/factories contém as classes de fábrica que são usadas para propagar os bancos de dados.
  • ./database/migrations nos permite modificar nosso modelo de dados
  • ./databse/seeders contém classes que propagam o banco de dados por meio de fábricas.

Executando o projeto em seu ambiente local

Primeiro, certifique-se de ter o PHP e o Composer instalados em sua máquina.

Requisitos mínimos de versão: PHP ^8.1 ; Compositor 2.5.4 .

1. Bifurque e clone o repositório.

2. cd no repositório e execute estes comandos CLI:

    composer update
    composer install
   

3. Renomeie seu arquivo .env.example para .env , remova as variáveis ​​da conexão mysql padrão e certifique-se de adicionar as três variáveis ​​a seguir:

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. Para ativar o servidor de desenvolvimento local, execute o comando Artisan CLI:

    php artisan serve
   

5. Para executar o conjunto de testes, execute o comando Artisan CLI:

    php artisan test