smithery/rzyfront

vendix-backend-api

Vendix backend API endpoint patterns: flat namespaced controllers, DTO-first request validation, ResponseService helpers, pagination responses, and service/controller responsibilities. Trigger: When creating API endpoints.

Installation

$ npx skills add smithery/rzyfront --skill vendix-backend-api

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery/rzyfront · top by installs.

npx skills add smithery/rzyfront

Browse all from smithery/rzyfront

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Skill metadata

Parsed from SKILL.md frontmatter.

Version2.0
LicenseMIT
More metadata
author
rzyfront
version
2.0
scope
["root"]
auto_invoke
Creating API endpoints

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,875 B
  • docs SUMMARY.md 48 B

History

  1. First recorded snapshot · 0 installs

SKILL.md

Vendix Backend API

Source of Truth

  • Controllers under apps/backend/src/domains///*.controller.ts
  • apps/backend/src/common/responses/response.service.ts
  • apps/backend/src/common/errors/
  • apps/backend/src/main.ts

Routing Pattern

Current controllers use flat namespaced prefixes such as:

  • store/...
  • organization/...
  • superadmin/...
  • public/...

Do not document old domains/:domain_id/... route patterns unless you are explicitly working with legacy code.

Controller Rules

  • Controllers stay thin: params/query/body DTOs, decorators/guards, one call into a service.
  • Services own business logic and Prisma access.
  • Use DTOs with global ValidationPipe rather than ad-hoc parsing.
  • Use VendixHttpException/ErrorCodes when standardized domain errors exist.

ResponseService

ResponseService currently exposes helpers including:

  • success(data, message?, meta?)
  • paginated(data, total, page, limit, message?)
  • noContent(message?)
  • created(data, message?)
  • updated(data, message?)
  • deleted(message?)

Use the helper that matches the intent rather than always falling back to success().

Pagination Pattern

Paginated services typically return raw data + total + page + limit inputs to the controller/response helper, not a nested { data, meta } structure for ResponseService.paginated().

Related Skills

  • vendix-backend
  • vendix-validation
  • vendix-error-handling
  • vendix-backend-auth