What problem does it solve?
It prevents fragile partner and webhook integrations by enforcing explicit, consistent HTTP route contracts at the VTEX IO boundary instead of scattering validation and response shaping across the codebase.
Core Features & Use Cases
- Route boundary clarity: Make required route params, headers, query values, and body fields validated and reflected in deterministic status codes and response shapes at the handler entrypoint.
- Middleware-driven consistency: Centralize repeated concerns like authentication, signature validation, and request normalization into shared middlewares to avoid drift across handlers.
- Latency-safe integration: Keep handlers thin and request-response bounded, returning timely acknowledgments (e.g., 202) while moving expensive or retry-prone work to async flows.
Use case example: You’re adding a public webhook endpoint for an order event and need predictable error handling and status codes so the partner’s retry logic behaves correctly.
Quick Start
Use this skill when reviewing or implementing VTEX IO service.json HTTP routes and their Node handlers to ensure each endpoint has explicit validation, consistent responses, and latency-safe behavior.
