API REST para gerenciar farmácias, medicamentos e respectivos estoques, através de um sistema de gestão. Essa API proverá os serviços para a execução do sistema possibilitando manter o cadastro de Farmácias, Medicamentos e seus Estoques com persistência dos dados no banco PostgreSQL.
- Popular Dados Iniciais: Popula dados iniciais no sistema.
- Criar Farmácia: Cria uma nova farmácia.
- Consultar Farmácias: Retorna a lista de todas as farmácias.
- Consultar Farmácia por CNPJ: Retorna informações sobre uma farmácia específica.
- Criar Medicamento: Cria um novo medicamento.
- Consultar Medicamentos: Retorna a lista de todos os medicamentos.
- Consultar Medicamento por Número de Registro: Retorna informações sobre um medicamento específico.
- Criar Estoque: Cria um novo item de estoque.
- Consultar Estoque: Retorna a lista de todos os itens de estoque.
- Consultar Estoque por CNPJ: Retorna a lista de itens de estoque para um CNPJ específico.
- Atualizar Transferência de Estoque: Atualiza a transferência de estoque entre farmácias.
- Excluir Estoque: Exclui um item de estoque.
- Adicionar camada de segurança.
- Desenvolver testes unitários.
Para o desenvolvimento da aplicação, foram utilizadas às tecnologias e dependências abaixo:
| Nome | Versão |
|---|---|
| Java | JDK 17 |
| Spring Boot | 3.2.0 |
| Maven | |
| Spring Web | |
| Spring Data JPA | |
| Validation | |
| Lombok | |
| ModelMapper | |
| PostgreSQL | |
| Swagger |
Para executar essa aplicação, você precisará atender a alguns pré-requisitos. Aqui estão os principais:
- Java Development Kit (JDK):
A aplicação está configurada para usar Java 17. Certifique-se de ter o JDK 17 ou uma versão posterior instalada em seu ambiente.
- PostgreSQL:
A aplicação utiliza o PostgreSQL como banco de dados. Certifique-se de ter uma instância do PostgreSQL instalada e em execução. Você também precisará configurar as credenciais do banco de dados no arquivo de configuração da aplicação.
- Maven:
Certifique-se de ter o Maven instalado. O Maven é usado para gerenciar as dependências e construir o projeto. Você pode baixar o Maven em Apache Maven.
- Ambiente de Desenvolvimento Integrado (IDE):
Embora não seja um requisito estrito, é altamente recomendável usar uma IDE como IntelliJ IDEA, Eclipse ou Visual Studio Code para facilitar o desenvolvimento e a execução da aplicação.
- Configuração do Banco de Dados:
Crie um banco de dados PostgreSQL farmaciadb e configure as propriedades de conexão no arquivo de configuração da aplicação.
- Configuração do Projeto:
Certifique-se de que o arquivo pom.xml está configurado corretamente e que todas as dependências estão atualizadas.
- Clone o Repositório: Clone o repositório do GitHub para o seu ambiente local usando o seguinte comando no terminal:
git clone https://github.com/patriciagrocha/pharmaPDV-api.git
- Abra o Projeto na IDE:
Abra o projeto clonado em sua IDE favorita (como IntelliJ, Eclipse ou Visual Studio Code).
- Configure o Banco de Dados:
Configure as propriedades do banco de dados no arquivo src/main/resources/application.properties ou src/main/resources/application.yml. Forneça as informações necessárias, como URL do banco de dados, nome do banco de dados, usuário e senha. 4. Build do Projeto:
Execute o comando de build usando o Maven:
./mvnw clean install
- Execute a Aplicação:
Após a conclusão do build, execute o aplicativo usando o seguinte comando:
mvn spring-boot:run
- Acesse a Aplicação:
Abra um navegador da web e acesse http://localhost:8080 (ou a porta que você configurou).
- Acesso através do swagger-ui: http://localhost:8080/api/v1/swagger-ui/index.html
Este projeto está sob a licença MIT.