https://github.com/wotancode/medpoint-api-restfull-2025
API Restful desarrollada con NestJS que permite la gestión de citas médicas para pacientes y médicos.
https://github.com/wotancode/medpoint-api-restfull-2025
nestjs
Last synced: about 1 year ago
JSON representation
API Restful desarrollada con NestJS que permite la gestión de citas médicas para pacientes y médicos.
- Host: GitHub
- URL: https://github.com/wotancode/medpoint-api-restfull-2025
- Owner: wotanCode
- License: mit
- Archived: true
- Created: 2025-05-11T02:50:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-13T12:25:41.000Z (about 1 year ago)
- Last Synced: 2025-06-09T23:40:37.435Z (about 1 year ago)
- Topics: nestjs
- Language: TypeScript
- Homepage:
- Size: 1.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🏥 MedPoint API
API Restful desarrollada con **NestJS** que permite la gestión de citas médicas para pacientes y médicos.
NestJS es un framework progresivo para construir aplicaciones del lado del servidor. Su estructura basada en módulos, su compatibilidad con TypeScript y el seguimiento estricto de patrones como MVC y DI (inyección de dependencias) lo hacen ideal para proyectos escalables, mantenibles y bien organizados.
---
## 📌 Características principales
* 🗖️ Pedir citas médicas por parte de pacientes.
* 💳 Confirmación de asistencia mediante pago (con integración sandbox de pasarela de pago).
* ✅ Confirmación o rechazo de citas por parte del médico (solo si está pagada).
* 📋 Listado de citas del día para cada médico.
* 📚 Agenda completa por paciente con validaciones de horario y solapamientos.
* 🔐 Autenticación mediante tokens simples.
* ⚖️ Control de roles: paciente y médico.
---
## 📌 Principios y buenas prácticas aplicadas
- ✅ Principios **SOLID**
- ✅ Programación orientada a objetos
- ✅ Arquitectura orientada a **dominio y responsabilidades claras**
- ✅ Uso de **DTOs, services, guards, interceptors y pipes**
- ✅ Pruebas unitarias y end-to-end
- ✅ Control de errores centralizado
- ✅ Estructura limpia y mantenible
---
## 🚀 Requisitos y instalación
Antes de comenzar, asegúrate de tener instalados los siguientes programas:
- [Node.js][nodejs-url] – Entorno de ejecución para JavaScript del lado del servidor.
- [Docker][docker-url] – Plataforma para contenedores que facilita la ejecución de la base de datos y otros servicios.
```sh
# Clonar el repositorio
git clone https://github.com/wotanCode/medpoint-api-restfull-2025.git
```
```sh
# Ingresar al proyecto
cd medpoint
```
```sh
# Instalar dependencias
npm install
```
## ▶️ Ejecución
1. Clonar el archivo `.env.template` y renombrarlo a `.env`.
2. Ajustar las variables de entorno según el uso. (Se pueden dejar los valores por defecto, excepto la de stripe la cual debe ser real para procesar pagos, aunque sea modo sandbox).
3. Levantar la base de datos.
```sh
docker-compose up -d
```
4. Levantar proyecto:
```sh
npm run start:dev
```
5. Ejecutar Seed. Get method
```sh
http://localhost:3000/api/seed
```
```bash
# Modo desarrollo
npm run start:dev
# Producción
npm run build
npm run start:prod
```
---
## 👥 Usuarios de prueba
Al ejecutar el **seed**, se insertarán los siguientes usuarios de prueba en la base de datos:
| Rol | Email | Contraseña |
|---------|----------------------------------|--------------|
| **Admin** | `admin@admin.com` | `Admin1234` |
| **Doctor** | `bob.doctor@example.com` | `Doctor1234` |
| **Patient** | `charlie@mymail.com` | `Abcd1234` |
| **Patient** | `diana.rivera@example.com` | `Abcd1234` |
| **Patient** | `elias.torres@example.com` | `Abcd1234` |
| **Patient** | `fatima.gonzalez@example.com`| `Abcd1234` |
Utiliza estos usuarios para realizar pruebas de autenticación y roles dentro de la API. Recuerda iniciar sesión con alguno de los usuarios de prueba para poder probar los distintos servicios, ya que todos requieren autenticación y algunos requieren diferentes tipos de autorización. Al hacer el login, estos regresan un Bearer Token con el cual podras consumir los distintos servicios.
---
## 📑 Documentación de la API (Swagger)
Para consultar la documentación completa de todos los endpoints disponibles, puedes acceder a la interfaz de **Swagger UI**, la cual te permitirá explorar y probar la API de manera interactiva.
Accede a la documentación en el siguiente enlace:
[http://localhost:3000/api](http://localhost:3000/api)
---
## 👮♂️ Roles y permisos
| Rol | Permisos |
| -------- | -------------------------------------------- |
| admin | Control completo |
| doctor | Confirmar/rechazar citas, ver agenda diaria. |
| patient | Solicitar y pagar citas. Ver su historial. |
---
## ✅ Validaciones clave
* ⛔ No se puede solicitar citas fuera del horario habilitado (07:00–12:00 / 14:00–18:00).
* ⛔ No se puede solicitar cita en horarios ya ocupados.
* ⛔ No se puede confirmar una cita que no ha sido pagada.
* ⚠️ Validaciones adicionales como formato de datos, campos requeridos y estados de cita.
---
## 🔐 Autenticación
Este proyecto utiliza un sistema de autenticación basado en **JWT (JSON Web Tokens)**.
- NestJS proporciona los mecanismos necesarios para generar, firmar y validar tokens.
- El token contiene información del usuario y su rol, permitiendo un control de acceso eficiente.
- La caducidad del token está configurada por defecto en **8 horas**.
> ⚙️ Podés ajustar el tiempo de expiración o la lógica de autenticación modificando la configuración en el módulo de autenticación
## 🧱 Base de Datos
Este proyecto utiliza **PostgreSQL** (versión 14.3) como sistema de gestión de base de datos. No es obligatorio para ejecutar el proyecto, pero en caso de que se deseé visualizar la BBDD, estas son las credenciales de ingreso.
### 📌 Detalles de conexión:
| Parámetro | Valor |
|------------|---------------------|
| Nombre | `medpointdb` |
| Host | `localhost` |
| Puerto | `5432` |
| Usuario | `postgres` |
| Contraseña | `mysecretpassword` |
---
## 🧪 Ejemplo caso de uso
### 🔧 1. Preparación Inicial
```bash
# 1. Asegúrate de que la base de datos esté corriendo
# 2. Ejecuta el seed para tener una base de datos limpia
GET http://localhost:3000/api/seed
```
### 🔧 2. Flujo de Prueba
#### a) Iniciar sesión como paciente
```bash
POST http://localhost:3000/api/auth/login
{
"email": "charlie@mymail.com",
"password": "Abcd1234"
}
```
Guarda el token que recibas.
#### b) Crear una cita (usando el token del paciente)
```bash
POST http://localhost:3000/api/appointments
Headers:
- Authorization: Bearer
Body:
{
"doctorId": "id-del-doctor",
"appointmentTime": "2024-03-20T10:00:00Z",
"reason": "Consulta de rutina",
"amount": 50.00
}
```
Guarda el ID de la cita creada.
#### c) Procesar el pago (usando el token del paciente)
```bash
POST http://localhost:3000/api/payments/process
Headers:
- Authorization: Bearer
Body:
{
"appointmentId": "id-de-la-cita-creada",
"paymentMethod": "card",
"paymentToken": "tok_visa" // Token de prueba de Stripe
}
```
#### d) Verificar el estado de la cita (usando el token del paciente)
```bash
GET http://localhost:3000/api/appointments/mine
Headers:
- Authorization: Bearer
```
#### e) Ver detalles del pago (usando token de admin o doctor)
```bash
GET http://localhost:3000/api/payments/:id-del-pago
Headers:
- Authorization: Bearer
```
### 🔧 3. Tokens de Prueba de Stripe
- `tok_visa`: Pago exitoso
- `tok_chargeDeclined`: Pago rechazado
- `tok_chargeCustomerFail`: Error en el procesamiento
### 🔧 4. Usuarios de Prueba
- Admin: `admin@admin.com` / `Admin1234`
- Doctor: `bob.doctor@example.com` / `Doctor1234`
- Paciente: `charlie@mymail.com` / `Abcd1234`
### 🔧 5. Verificación de Estados
- La cita debe cambiar de `pending` a `paid` después del pago exitoso
- Debe crearse un registro en la tabla de pagos
- El doctor y admin deben poder ver los detalles del pago
### 🔧 6. Notas Importantes
1. Los tokens de prueba de Stripe (`tok_visa`, etc.) son valores fijos que siempre funcionarán en el entorno de pruebas.
2. Para ver los detalles de un pago, puedes usar:
- El ID de Stripe (ejemplo: `ch_3ROHbuQ7dYv9g8xd1ZcJQdyt`)
- El UUID de nuestra base de datos
3. La respuesta de un pago exitoso incluirá:
```json
{
"success": true,
"paymentId": "ch_3ROHbuQ7dYv9g8xd1ZcJQdyt",
"amount": 50.00,
"status": "succeeded"
}
```
### 🔧 7. Posibles Errores
1. **Pago ya realizado**: Si intentas pagar una cita que ya está pagada
2. **Token inválido**: Si usas un token de prueba incorrecto
3. **Permisos insuficientes**: Si intentas acceder a endpoints sin el rol adecuado
4. **Cita no encontrada**: Si el ID de la cita no existe
---
## 🧰 Tecnologías usadas
- [![NestJS][nestjs-badge]][nestjs-url] Framework para construir aplicaciones server-side eficientes y escalables.
- [![TypeScript][typescript-badge]][typescript-url] Superset de JavaScript con tipado estático.
- [![Docker][docker-badge]][docker-url] Plataforma para desarrollar, enviar y ejecutar aplicaciones dentro de contenedores.
- [![PostgreSQL][postgresql-badge]][postgresql-url] Sistema de base de datos relacional avanzado.
- [![TypeORM][typeorm-badge]][typeorm-url] ORM para TypeScript y JavaScript compatible con múltiples bases de datos.
- [![Jest][jest-badge]][jest-url] Framework de testing con enfoque en simplicidad.
- [![Passport][passport-badge]][passport-url] Middleware de autenticación para Node.js.
- [![Class Validator][classvalidator-badge]][classvalidator-url] Validación basada en decoradores para TypeScript.
---
## 👨💻 Autor
Desarrollado con ❤️ por Pedro Yanez
[![GitHub][github-badge]][github-url] [![LinkedIn][linkedin-badge]][linkedin-url]
---
## 📜 Licencia
Este proyecto está bajo la licencia MIT. Consulta el archivo `LICENSE` para más detalles.
[nodejs-url]: https://nodejs.org/
[nestjs-url]: https://nestjs.com/
[nestjs-badge]: https://img.shields.io/badge/NestJS-E0234E?style=for-the-badge&logo=nestjs&logoColor=white
[typescript-url]: https://www.typescriptlang.org/
[typescript-badge]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white
[docker-url]: https://www.docker.com/
[docker-badge]: https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white
[postgresql-url]: https://www.postgresql.org/
[postgresql-badge]: https://img.shields.io/badge/PostgreSQL-4169E1?style=for-the-badge&logo=postgresql&logoColor=white
[typeorm-url]: https://typeorm.io/
[typeorm-badge]: https://img.shields.io/badge/TypeORM-262627?style=for-the-badge&logo=typeorm&logoColor=white
[jest-url]: https://jestjs.io/
[jest-badge]: https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white
[passport-url]: http://www.passportjs.org/
[passport-badge]: https://img.shields.io/badge/Passport-34E27A?style=for-the-badge&logo=passport&logoColor=white
[classvalidator-url]: https://github.com/typestack/class-validator
[classvalidator-badge]: https://img.shields.io/badge/Class_Validator-000000?style=for-the-badge&logo=github&logoColor=white
[github-url]: https://github.com/wotancode
[github-badge]: https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white
[linkedin-url]: https://www.linkedin.com/in/pedro-yanez/
[linkedin-badge]: https://img.shields.io/badge/LinkedIn-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white