Skip to main content
skill CX Codex

vtex-io-http-routes — Claude Code skill: HTTP routes in VTEX IO

Guides the design of HTTP endpoints in a VTEX IO backend service: route boundaries, middleware chains, request validation and response shape.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add vtex/skills --skill vtex-io-http-routes -a claude-code
Open on GitHub

What vtex-io-http-routes does

The skill kicks in when a VTEX IO service has to expose HTTP endpoints through service.json routes and handlers under node/. It covers where a route boundary sits, how to compose middleware, and how to describe params, query values, headers and body shape close to the handler.

Inside are decision rules and hard constraints with code samples. A handler must keep the contract explicit: if it delegates right away without validating required params, the skill says stop and write the contract first. Repeated signature checks or request normalization belong in middleware, not copied across handlers. Long loops and batch imports in a route are a signal to move the work to an async flow and answer 202.

There is a recommended layout: node/routes/ grouped by domain, such as orders.ts and webhooks.ts, with node/middlewares/ alongside. A public route counts as an external contract, so widening one to public without reviewing validation and auth is a bad idea. The skill is not for GraphQL APIs, app policies in manifest.json, or runtime tuning — it will not help there.

What it helps with

  • spell out a webhook contract for a partner
  • move a signature check into middleware
  • split a synchronous route from background processing
  • align status codes and response shape across a route family
  • group route files by bounded domain

Example prompts for the agent

  • add a partner callback webhook to service.json and a handler in node/routes
  • check that the order handler validates params before calling the client
  • extract the x-signature check into middleware and wire it into the order routes

How to install vtex-io-http-routes

1Skills CLI (Vercel)

npx skills add vtex/skills --skill vtex-io-http-routes -a claude-code

2Manually: put the files in place

~/.claude/skills/vtex-io-http-routes/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/vtex-io-http-routes/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about vtex-io-http-routes

How do I install vtex-io-http-routes in Claude?

Run npx skills add vtex/skills --skill vtex-io-http-routes -a claude-code. The skill lands in ~/.claude/skills/vtex-io-http-routes/SKILL.md.

What does vtex-io-http-routes do?

It helps you design and review HTTP endpoints in a VTEX IO service: route boundaries, handler structure, middleware, request validation and response modeling for service.json routes.

What is this skill not meant for?

It does not cover GraphQL APIs, app policies in manifest.json, service runtime tuning, or async event and worker flows.

Similar skills

Everything for Backend and APIs →

From the same set8

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor