GPM Challenge

💻 Sobre o projeto

O GPM Challenge é um projeto em laravel com o objetivo de prover uma api para com recursos de listagem, criação atualização e exclusão de dados, fornecendo endpoints, estrutura de dados e respostas adequadas. Todas as operações são seguramente persistidas em um banco de dados relacional.

⚠️ Requisitos do Projeto

• Laravel 10
• PHP ^8.1
• MySQL ^5.6
• NodeJS ^18.16
• Composer ^2.5

🧰 Ferramenta para Teste de Requisições HTTP

Recomendamos o Insomnia, no projeto você encontrará um arquivo chamado insomnia_setup.json nele estão contidas as configuração de exemplo das requisições já montado, pronto para ser importado e utilizado direto dentro do insomnia.

🏗️ Instalação

Clone o repositório para o seu computador e acesse a pasta do projeto:

//clone
git clone https://github.com/mariolucasdev/gpm-challenge-backend.git

//acesso a pasta
cd gpm-challenge-backend

Renomeie o arquivo .env.example para .env na raiz do projeto e configure seu banco de dados:

Crie um bando de dados, para menos configurações nomeie seu banco de dados como gpm_challenge_backend e conclua as configurações do seu .env.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=gpm_challenge_backend //nome do seu banco de dados
DB_USERNAME=root
DB_PASSWORD=

Instale as dependências do composer:

composer install
ou
composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist

Gere sua chave da aplicação:

php artisan key:generate

Instale as dependências package.json

npm install

Execute as migrações do banco de dados e os seeders:

php artisan migrate --seed

Execute o servidor:

php artisan serve

Seguido todo os passos agora você conseguirá acessar os recursos da api, através dos enpoints abaixo.

Api Endoints

Marcas

Método	Endpoint	Parâmetros	Descrição	Retorno
GET	api/brands	---	Busca lista de marcas.	200

GET - api/brands

// Headers
// Content-Type: application/json
// Accept: application/json

// Retorno
{
    "data": [
        {
            "id": 1,
            "name": "Electrolux"
        },
        {...},
        {...}
    ]
}

Eletrodomésticos

Método	Endpoint	Parâmetros	Descrição	Status
POST	api/appliance	name, description, eletric_tension, brand_id	Busca lista de marcas.	201 or 422
GET	api/appliance	------	Listagem de Eletrodomésticos.	200
GET	api/appliance/:id	------	Exibir 1 eletrodoméstico pelo id.	200 ou 404
PUT	api/appliance/:id	name, description, eletric_tension, brand_id	Editar eletrodoméstico.	200, 404 or 422
DELETE	api/appliance/:id	------	Excluir um Eletrodomésticos.	200 ou 404

POST - api/appliance

// Headers
// Content-Type: application/json
// Accept: application/json

// Envio
{
	"name" : "Geladeira Frost Free",
	"description": "Produto versátil.",
	"eletric_tension" : "220v",
	"brand_id" : 2
}

// Retorno
{
	"id": 72,
	"name": "Geladeira Frost Free",
	"description": "Produto versátil.",
	"eletric_tension": "220v",
	"brand_id": 2,
	"created_at": "2023-06-14 17:33:11",
	"updated_at": "2023-06-14 17:33:11",
	"brand": "Brastemp"
}

GET - api/appliance

// Headers
// Accept: application/json

// Retorno
[
    {
		"id": 42,
		"name": "Geladeira Frost Free",
		"description": "Produto versátil.",
		"eletric_tension": "220v",
		"brand_id": 1,
		"created_at": "2023-06-14 10:43:50",
		"updated_at": "2023-06-14 10:43:50",
		"brand": "Electrolux"
	},
    {...},
    {...}
]

GET - api/appliance/:id

// Headers
// Accept: application/json

// Retorno
{
	"id": 68,
	"name": "Geladeira Frost Free",
	"description": "Produto versátil.",
	"eletric_tension": "220v",
	"brand_id": 2,
	"created_at": "2023-06-14 14:15:44",
	"updated_at": "2023-06-14 14:15:44",
	"brand": "Brastemp"
}

PUT - api/appliance/:id

// Headers
// Content-Type: application/json
// Accept: application/json

// Envio
{
	"name" : "Cooktop",
	"description": "05 bocas.",
	"eletric_tension" : "110v",
	"brand_id" : 5
}

// Retorno
{
	"id": 67,
	"name": "Cooktop",
	"description": "05 bocas.",
	"eletric_tension": "110v",
	"brand_id": 5,
	"created_at": "2023-06-14 14:14:32",
	"updated_at": "2023-06-14 14:14:50",
	"brand": "LG"
}

DELETE - api/appliance/:id

receberá um status 200 caso tenha corrido tudo bem ou 404 caso não exista o id no banco de dados.

🧪 Execução de Testes

Teste de unidade:

php artisan test --parallel

Teste de análise estática

vendor/bin/phpstan analyse

Teste de estilo de código

vendor/bin/pint --test