VetSystem API

Descrição

A VetSystem API é uma API REST que permite gerenciar pacientes (animais) em um sistema veterinário. Ela suporta operações como listar, criar, atualizar, visualizar e excluir pacientes, além de fornecer respostas padronizadas para erros e resultados. A API está documentada com Swagger e foi construída com Golang.

Endpoints

Base Path

/api/v1/
Exemplo:
- 127.0.0.1/api/v1/patients

1. Listar Pacientes

Endpoint: GET /patients
Descrição: Lista todos os pacientes cadastrados no sistema.
Respostas:
- 200 OK: Retorna a lista de pacientes.
- 500 Internal Server Error: Erro no servidor.

2. Visualizar Paciente

Endpoint: GET /patient/{id}
Descrição: Exibe os detalhes de um paciente específico.
Parâmetros:
- id (path): Identificador do paciente.
Respostas:
- 200 OK: Retorna os detalhes do paciente.
- 400 Bad Request: Solicitação inválida.
- 404 Not Found: Paciente não encontrado.

3. Criar Paciente

Endpoint: POST /patient/create
Descrição: Cria um novo paciente no sistema.

Corpo da Requisição:

{
  "age": 5,
  "breed": "Golden Retriever",
  "cpf": "12345678900",
  "name": "Rex",
  "nameTutor": "João Silva",
  "phone": "11999999999",
  "species": "Cachorro",
  "temperature": 38.5,
  "weight": 30
}

Respostas:
- 200 OK: Paciente criado com sucesso.
- 400 Bad Request: Erro nos dados fornecidos.
- 500 Internal Server Error: Erro no servidor.

4. Atualizar Paciente

Endpoint: PUT /patient/{id}
Descrição: Atualiza as informações de um paciente existente.
Parâmetros:
- id (path): Identificador do paciente.

Corpo da Requisição:

{
  "age": 6,
  "breed": "Golden Retriever",
  "name": "Rex",
  "nameTutor": "João Silva",
  "phone": "11999999999",
  "species": "Cachorro",
  "state": "São Paulo",
  "temperature": 38.7,
  "weight": 32
}

Respostas:
- 200 OK: Paciente atualizado com sucesso.
- 400 Bad Request: Erro nos dados fornecidos.
- 404 Not Found: Paciente não encontrado.

5. Excluir Paciente

Endpoint: DELETE /patient/{id}
Descrição: Exclui um paciente específico.
Parâmetros:
- id (path): Identificador do paciente.
Respostas:
- 200 OK: Paciente excluído com sucesso.
- 404 Not Found: Paciente não encontrado.

6. Bad Request Pacientes

Endpoint: GET /patient
Descrição: Simulação de requisição inválida (Bad Request).
Respostas:
- 200 OK: Simula um Bad Request para pacientes.

Estrutura das Respostas

As respostas da API seguem um formato padrão com os campos:

{
  "data": { /* Dados do Paciente */ },
  "message": "Mensagem sobre a operação realizada"
}

Swagger

http://127.0.0.1:8080/swagger/index.html
Descrição: Executar testes e verificar a documentação no swagger.

Execução com Docker Compose

Para executar a API utilizando Docker Compose, siga os seguintes passos:

Criar a imagem Docker: Execute o comando para buildar a imagem:
```
docker build -t gk-vetsystem .
```

Executar a API: Utilizando o docker-compose.yml fornecido:

version: '3'
services:
  api_gk:
    image: gk-vetsystem
    ports:
      - "8080:8080"
    command: go run main.go

Para iniciar a API:

docker-compose up

Acessar a API: Acesse a API via http://localhost:8080.

Tecnologias Utilizadas

Golang: Linguagem de programação principal.
Docker: Para containerização da aplicação.
Swagger: Para documentação da API.

Contribuição

Faça um fork do repositório.
Crie uma nova branch: git checkout -b feature/nova-funcionalidade.
Faça commit das suas alterações: git commit -m 'Adiciona nova funcionalidade'.
Envie suas alterações: git push origin feature/nova-funcionalidade.
Abra um Pull Request.

Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Esse README fornece as instruções básicas para executar o projeto e documenta os endpoints da API.

VetSystem API

Descrição

Endpoints

Base Path

/api/v1/
Exemplo:
- http://localhost/api/v1/patients

1. Listar Pacientes

Endpoint: GET /patients
Descrição: Lista todos os pacientes cadastrados no sistema.
Respostas:
- 200 OK: Retorna a lista de pacientes.
- 500 Internal Server Error: Erro no servidor.

2. Visualizar Paciente

Endpoint: GET /patient/{id}
Descrição: Exibe os detalhes de um paciente específico.
Parâmetros:
- id (path): Identificador do paciente.
Respostas:
- 200 OK: Retorna os detalhes do paciente.
- 400 Bad Request: Solicitação inválida.
- 404 Not Found: Paciente não encontrado.

3. Criar Paciente

Endpoint: POST /patient/create
Descrição: Cria um novo paciente no sistema.

Corpo da Requisição:

{
  "age": 5,
  "breed": "Golden Retriever",
  "cpf": "12345678900",
  "name": "Rex",
  "nameTutor": "João Silva",
  "phone": "11999999999",
  "species": "Cachorro",
  "temperature": 38.5,
  "weight": 30
}

Respostas:
- 200 OK: Paciente criado com sucesso.
- 400 Bad Request: Erro nos dados fornecidos.
- 500 Internal Server Error: Erro no servidor.

4. Atualizar Paciente

Endpoint: PUT /patient/{id}
Descrição: Atualiza as informações de um paciente existente.
Parâmetros:
- id (path): Identificador do paciente.

Corpo da Requisição:

{
  "age": 6,
  "breed": "Golden Retriever",
  "name": "Rex",
  "nameTutor": "João Silva",
  "phone": "11999999999",
  "species": "Cachorro",
  "state": "São Paulo",
  "temperature": 38.7,
  "weight": 32
}

Respostas:
- 200 OK: Paciente atualizado com sucesso.
- 400 Bad Request: Erro nos dados fornecidos.
- 404 Not Found: Paciente não encontrado.

5. Excluir Paciente

Endpoint: DELETE /patient/{id}
Descrição: Exclui um paciente específico.
Parâmetros:
- id (path): Identificador do paciente.
Respostas:
- 200 OK: Paciente excluído com sucesso.
- 404 Not Found: Paciente não encontrado.

6. Bad Request Pacientes

Endpoint: GET /patient
Descrição: Simulação de requisição inválida (Bad Request).
Respostas:
- 200 OK: Simula um Bad Request para pacientes.

Estrutura das Respostas

As respostas da API seguem um formato padrão com os campos:

{
  "data": { /* Dados do Paciente */ },
  "message": "Mensagem sobre a operação realizada"
}

Swagger

http://localhost/swagger/index.html
Descrição: Executar testes e verificar a documentação no swagger.

Execução com Docker Compose

Para executar a API utilizando Docker Compose, siga os seguintes passos:

Criar a imagem Docker: Execute o comando para buildar a imagem:
```
docker build -t gk-vetsystem .
```

Executar a API: Utilizando o docker-compose.yml fornecido:

version: '3'
services:
  api_gk:
    image: gk-vetsystem
    ports:
      - "80:8080"
    command: go run main.go

Para iniciar a API:

docker compose up

Acessar a API: Acesse a API via http://localhost:80.

Tecnologias Utilizadas

Golang: Linguagem de programação principal.
Docker: Para containerização da aplicação.
Swagger: Para documentação da API.

Contribuição

Faça um fork do repositório.
Crie uma nova branch: git checkout -b feature/nova-funcionalidade.
Faça commit das suas alterações: git commit -m 'Adiciona nova funcionalidade'.
Envie suas alterações: git push origin feature/nova-funcionalidade.
Abra um Pull Request.

Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Esse README fornece as instruções básicas para executar o projeto e documenta os endpoints da API.

# README

VetSystem API

Descrição

Endpoints

Base Path

1. Listar Pacientes

2. Visualizar Paciente

3. Criar Paciente

4. Atualizar Paciente

5. Excluir Paciente

6. Bad Request Pacientes

Estrutura das Respostas

Swagger

Execução com Docker Compose

Tecnologias Utilizadas

Contribuição

Licença

Esse README fornece as instruções básicas para executar o projeto e documenta os endpoints da API.

VetSystem API

Descrição

Endpoints

Base Path

1. Listar Pacientes

2. Visualizar Paciente

3. Criar Paciente

4. Atualizar Paciente

5. Excluir Paciente

6. Bad Request Pacientes

Estrutura das Respostas

Swagger

Execução com Docker Compose

Tecnologias Utilizadas

Contribuição

Licença

# Packages