Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Nelsoncg98/InnovaTech/llms.txt

Use this file to discover all available pages before exploring further.

The Catalog Service (servicio-catalogo) is the authoritative source of product data in InnovaTech SOA. It stores and manages product definitions — including names, descriptions, prices, and categories — in a MongoDB database, making it well-suited for the flexible, document-oriented nature of product catalogs where attributes vary between product types. All catalog endpoints are accessible to clients through the API Gateway at the /api/v1/catalogo/** namespace, and the service also generates a fully interactive Swagger UI for local development and testing.

Base Path

Access the Catalog API through the gateway during normal operation:
http://localhost:8080/api/v1/catalogo/**
If you need to reach the service directly — for local development, debugging, or browsing Swagger UI — it listens on its own port:
http://localhost:8084

Interactive Documentation

The catalog service uses SpringDoc OpenAPI 2.3.0 to generate API documentation automatically from its controller annotations. No manual specification maintenance is required — the docs always reflect the live codebase.
ResourceURL
Swagger UI (browser)http://localhost:8084/swagger-ui.html
OpenAPI JSON spechttp://localhost:8084/api-docs
Open the Swagger UI in your browser to view every available endpoint, inspect request/response schemas, and execute test requests directly against the running service.
Download the raw OpenAPI specification from http://localhost:8084/api-docs to import into Postman as a collection, or feed it into OpenAPI code generators (such as openapi-generator-cli) to automatically produce typed client SDKs for TypeScript, Python, or any other supported language.

Data Store

The catalog service connects to MongoDB using the database innovatech_catalogo. Product documents are schema-flexible by design, but typical fields include:
FieldDescription
nombreProduct display name
descripcionFull product description
precioUnit price
categoriaProduct category or classification
The MongoDB URI is configured in the service’s application.yml:
spring:
  data:
    mongodb:
      uri: mongodb://admin:secretpassword@localhost:27017/innovatech_catalogo?authSource=admin
The MongoDB instance used by this service is started via docker-compose from the project root. Ensure the container is running before starting the catalog service, or connections will be refused on startup.

Running the Service

Start the catalog service locally from the project root:
cd servicio-catalogo && mvn spring-boot:run
The service will start on port 8084. Once running, the Swagger UI at http://localhost:8084/swagger-ui.html becomes available immediately and lists all endpoints with their current request/response contracts.
The full list of catalog endpoints — product creation, retrieval, update, and deletion — is available exclusively through the Swagger UI at http://localhost:8084/swagger-ui.html. The catalog service is maintained by the catalog team and its endpoint contracts are auto-documented directly from source code, ensuring the Swagger UI is always up to date.

Build docs developers (and LLMs) love