Endpoints - bootcamp-uchile-2026/grupo-2-backend GitHub Wiki

Endpoints

La API REST de BuenOrigen Backend expone operaciones consultables por Frontend y Mobile. Los contratos definitivos se consultan en Swagger y en los controllers de develop.

Alcance documental: contratos descritos en la Wiki previamente compartida y cambios aprobados hasta el 13 de octubre de 2026 (incluido PR #59). Esta página no reemplaza la especificación OpenAPI generada desde la rama develop. Los nombres internos de código siguen la convención en inglés; las rutas HTTP conservan el contrato publicado.

Operaciones de catálogo documentadas como implementadas

Método Ruta Funcionalidad Controller
GET /productos Búsqueda de Productos src/productos/productos.controller.ts
GET /productos/ofertas Carrusel de Ofertas src/productos/productos.controller.ts
GET /productos/mas-vendidos Productos más Populares src/productos/productos.controller.ts
GET /productos/nuevos Novedades o Nuevos Productos src/productos/productos.controller.ts
GET /productos/:productoId Detalle de Producto src/productos/productos.controller.ts
GET /productos/:productoId/huella-verde Huella Verde del Producto src/productos/productos.controller.ts
GET /productos/:productoId/valoraciones Valoraciones de Producto src/productos/productos.controller.ts
GET /productos/:productoId/relacionados Productos Relacionados src/productos/productos.controller.ts
GET /categorias/:categoriaId/subcategorias Subcategorías Existentes src/subcategorias/subcategorias.controller.ts
GET /subcategorias/:subcategoriaId/productos Productos por Subcategoría src/subcategorias/subcategorias.controller.ts
GET /subcategorias/:subcategoriaId/productos/populares Productos más Populares por Subcategoría src/subcategorias/subcategorias.controller.ts
GET /emprendedores Nuestros Emprendedores src/emprendedores/emprendedores.controller.ts
GET /emprendedores/:emprendedorId Perfil de Emprendedor src/emprendedores/emprendedores.controller.ts
GET /emprendedores/:emprendedorId/productos Productos del Emprendedor src/emprendedores/emprendedores.controller.ts

Parámetros y comportamientos relevantes

  • /productos?buscar=bolsa: consulta de búsqueda; sin coincidencias, lista vacía.
  • /productos/mas-vendidos?cantidad=5: cantidad representa el máximo de resultados; los valores inválidos se gestionan con 400 Bad Request según las validaciones integradas.
  • /productos/:productoId/relacionados?cantidad=4: restringe los resultados a productos relacionados; exige validar el identificador y la cantidad.
  • /emprendedores?cantidad=4: limitación opcional; los valores informados deben respetar las reglas de validación del controller.
  • Identificadores de recursos inexistentes: documentar 404 Not Found conforme a cada controller.
  • Identificadores o consultas mal formadas: documentar 400 Bad Request donde aplique, conforme al contrato aprobado en PR #59.

La presencia de un ejemplo de ruta no sustituye los valores de obligatoriedad y tipo publicados por Swagger.

Contratos propuestos por UX/UI (no atribuidos al código)

Se identificaron necesidades de blog, favoritos, carrito, autenticación, direcciones, compras, devoluciones, puntos verdes y gestión privada del emprendedor. Las rutas antiguamente sugeridas para estas áreas son propuestas, no interfaces confirmadas de develop. No deben utilizarse como contrato de integración hasta su definición técnica.

Clientes y usuarios

Existen antecedentes de integración y corrección de funcionalidades de clientes (incluido PR #52). El inventario preciso de endpoints de clientes debe derivarse de sus controllers vigentes; no se equiparan automáticamente a /usuario/me, autenticación JWT o administración privada de perfiles.

Documentación relacionada