Este projeto consiste no desenvolvimento de um sistema de gerenciamento de fórmulas de manipulação para uma farmácia de manipulação. O sistema permitirá que os clientes solicitem fórmulas personalizadas, e cada fórmula poderá estar associada a vários ativos.
OTHER License
Este projeto consiste em uma API desenvolvida para uma farmácia de manipulação, com o objetivo de gerenciar clientes, fórmulas de manipulação e os ativos utilizados nessas fórmulas. A API foi construída utilizando o framework Laravel, seguindo os princípios RESTful para garantir fácil integração e escalabilidade.
Clone o repositório:
git clone https://github.com/rrodrigofranco/FormulaManager
cd FormulaManager
Instale as dependências do projeto:
composer install
Configure o arquivo .env:
cp .env.example .env
php artisan key:generate
Configure o banco de dados no arquivo .env:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=nome_do_banco
DB_USERNAME=usuario
DB_PASSWORD=senha
Execute as migrações:
php artisan migrate
Execute o composer:
composer install
Para acessar os endpoints da API, você precisa fornecer um token de autenticação válido. O token deve ser incluído no cabeçalho Authorization
das suas requisições HTTP.
Para criar um novo usuário na sua aplicação, envie uma requisição POST para a rota /v1/auth
com os seguintes parâmetros:
Parâmetros da Requisição:
{
"name": "Exemplo de Usuário",
"email": "[email protected]",
"password": "senha123",
"password_confirmation": "senha123"
}
Após a criação do usuário, você receberá uma resposta contendo um token de autenticação. Esse token deve ser utilizado para autenticar suas requisições subsequentes.
GET /api/v1/clientes
POST /api/v1/clientes
nome
: string, obrigatório.cpf
: string, obrigatório.telefone
: string, opcional.GET /api/v1/clientes/{id}
PUT /api/v1/clientes/{id}
nome
: string, opcional.cpf
: string, opcional.telefone
: string, opcional.DELETE /api/v1/clientes/{id}
GET /api/v1/formulas
POST /api/v1/formulas
nome
: string, obrigatório.descricao
: string, opcional.cliente_id
: integer, obrigatório.GET /api/v1/formulas/{id}
PUT /api/v1/formulas/{id}
nome
: string, opcional.descricao
: string, opcional.cliente_id
: integer, opcional.DELETE /api/v1/formulas/{id}
GET /api/v1/ativos
POST /api/v1/ativos
nome
: string, obrigatório.descricao
: string, opcional.GET /api/v1/ativos/{id}
PUT /api/v1/ativos/{id}
nome
: string, opcional.descricao
: string, opcional.DELETE /api/v1/ativos/{id}
Os teste podem ser realizados através do seguinte comando:
php artisan test
A documentação da API foi gerada utilizando o Swagger. Para acessá-la, inicie o servidor localmente e acesse o endpoint /api/documentation
no seu navegador.