-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathreadme
More file actions
34 lines (25 loc) · 798 Bytes
/
readme
File metadata and controls
34 lines (25 loc) · 798 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# api-swagger-docs
Documentación interactiva de una API (Products & Carts) usando **OpenAPI/Swagger** sobre Node.js/Express.
## 📚 Características
- Definición OpenAPI centralizada (`swagger.yaml`).
- Swagger UI servido en `/api/docs`.
- Esquemas de modelos (`Product`, `Cart`), parámetros, respuestas y ejemplos.
- Soporte para auth (Bearer) listo para ampliar.
## 🤞 Stack
- Node.js, Express
- swagger-ui-express
- YAML (OpenAPI 3)
## 🚀 Inicio rápido
npm ci
npm run dev
# abre http://localhost:3000/api/docs
## 📜 Estructura
/src
/routes
/middlewares
/swagger.yaml
## ✍️ Mantenimiento de la spec
- Agrega/actualiza paths y schemas en `swagger.yaml`.
- Valida con un linter (ej. @redocly/cli) antes de hacer commit.
## 👍 Licencia
MIT