/global-health

Primary LanguageTypeScriptMIT LicenseMIT

saude

Descrição do Projeto

API Rest Global Health

🌐 Deploy

O deploy foi feito utilizando o heroku para a hospedagem da aplicação.

Links úteis.

Documentação da API - Global Health

Como usar a API

Pré-requisitos

Para usar esta API é preciso instalar as seguintes ferramentas:

Para editar o código eu recomendo:

Para testar as rotas você pode usar:

Rodando o Back End (servidor)

# Clone este repositório
 git clone https://github.com/MathLopes1/global-health.git

# Acesse a pasta do projeto 
 cd global-health

# crie um arquivo .env seguindo o modelo do arquivo .env.exemplo e preencha os campos.

# Instale as dependências
 npm i

# Faça o build da aplicação para JavaScript
npm rum build
           
# Execute a aplicação em modo de Produção
npm run start

# Execute a aplicação em modo de desenvolvimento
npm run start:dev

# Execute os testes            
npm run test            
            
# O servidor iniciará na porta: 3000

👨‍💼 ROTAS DE PACIENTES

REQUEST - (POST)

Para cadastrar pacientes.

POST - localhost:3000/api/v1/patient

Exemplo de body:

{
    "name": "Matheus Lopes da Silva",
    "healthInsuranceCardId": "62dabab25d042a616cdbe249",
    "address": "Rua Ledinha, 17"
}

REQUEST - (GET)

Para listar todos os pacientes

GET - localhost:3000/api/v1/patient

REQUEST - (GET)

Para listar um paciente por id

GET - localhost:3000/api/v1/patient/:patientId

REQUEST - (PUT)

Para atualizar um paciente

PUT - localhost:3000/api/v1/patient/:patientId

Exemplo de body:

{
    "name": "Matheus Lopes da Silva",
}

REQUEST - (DELETE)

Para deletar um paciente

DELETE - localhost:3000/api/v1/patient/:patientId

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

👨‍💻 Autor

💻Matheus Lopes

Developer

📝 LICENÇA

Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.