Home

Bem-vindo à Wiki da API do Projeto NPVet 🐾

Introdução

Bem-vindo à documentação oficial do projeto NPVet. Esta wiki é destinada a fornecer informações sobre a API Spring Boot e o banco de dados PostgreSQL que compõem o sistema de gestão de hospital veterinário NPVet.

Objetivo 🎯

O NPVet é uma aplicação desenvolvida para atender às necessidades de hospitais veterinários, proporcionando uma maneira eficiente de gerenciar informações relacionadas a pacientes, consultas, tratamentos e muito mais. Esta wiki tem o objetivo de fornecer documentação detalhada sobre como utilizar a API e entender a estrutura do banco de dados.

Tecnologias Utilizadas 🛠️

Java Spring Hibernate Postgres Postman

Diagramas do Projeto 📊

Nossa documentação inclui os seguintes diagramas:

Diagrama de Casos de Uso: Uma representação visual dos casos de uso do sistema NPVet.
Diagrama Entidade-Relacionamento (DER): Uma representação visual da estrutura do banco de dados e das entidades envolvidas.

Conteúdo da Wiki 📚

Documentação da API
- Rotas da API: Uma lista completa das rotas disponíveis na API, incluindo exemplos de solicitações e respostas.
- Códigos de Erro: Uma descrição dos códigos de erro que podem ser retornados pela API e o que eles significam.
Estrutura do Banco de Dados
- Entidades e Propriedades: Uma especificação das entidades no banco de dados, incluindo detalhes sobre suas propriedades e relacionamentos.
Guia de Instalação
- Instruções de Instalação: Um guia passo a passo sobre como configurar e executar o projeto NPVet em seu ambiente local.
Testando os Endpoints com Postman 🧪
- Como Testar com Postman: Um guia detalhado sobre como configurar e usar o Postman para testar as rotas da API NPVet.