EletroAPI é uma API para estudos com esta arquitetura. A API é projetada para fornecer endpoints que permitem a criação, leitura, atualização e exclusão de registros de eletrodomésticos no banco de dados.
Siga as etapas abaixo para instalar e configurar o projeto EletroAPI:
-
Certifique-se de ter o Composer instalado em sua máquina.
-
Clone o repositório EletroAPI:
git clone https://github.com/guipedrazzi/eletroapi.git
-
Acesse o diretório do projeto:
cd eletroapi
-
Instale as dependências do projeto usando o Composer:
composer install
-
Crie o arquivo de ambiente
.env
a partir do arquivo.env.example
:cp .env.example .env
-
Configure as informações de conexão com o banco de dados no arquivo
.env
:Crie o banco de dados eletroapi no MySQL ou MariaDB e o coloque na constante DB_DATABASE no .env
-
Execute as migrações do banco de dados:
php artisan migrate
-
Por fim, inicie o servidor de desenvolvimento:
php artisan serve
A seguir estão os endpoints disponíveis na API EletroAPI:
POST /api/device
Cria um novo eletrodoméstico.
- Campos obrigatórios: brand (string), name (string), description (string), voltage (string)
- Retorno: errors (array), status (integer), msg (string)
PUT /api/device/{id}
Atualiza os dados de um eletrodoméstico.
- Campos obrigatórios: id (integer), brand (string), name (string), description (string), voltage (string)
- Retorno: errors (array), status (integer), msg (string)
DELETE /api/device/{id}
Remove um eletrodoméstico.
- Campos obrigatórios: id (integer)
- Retorno: errors (array), status (integer), msg (string)
GET /api/device
Lista todos os eletrodomésticos.
- Retorno: errors (array), status (integer), devices (array)