Files
antd-admin/apps/basic/.github/instructions/api.instructions.md
T
Cursor Agentandzuiidea 468cf864d9 docs: harden agent UI/quality instructions
Register golden paths, YAGNI, and verify:ui in app instructions and Cursor rules.

Co-authored-by: zuiidea <zuiiidea@gmail.com>
2026-10-17 13:56:01 +00:00

1.1 KiB


applyTo: "src/api//*.ts,src/utils/http.ts,src/mocks/handlers//*.ts,src/mocks/createHandler.ts"

description: "Use when editing API clients, schemas, HTTP behavior, response types, or MSW endpoint handlers. Keywords: api, http, schema, zod, handler, endpoint, auth, users."

API Instructions

Purpose

Maintain strict API contracts and consistent server/client mock behavior.

Do

  • Keep request/response shapes schema-driven and type-safe.
  • New endpoints and client mutations/queries must use Zod schemas at the boundary.
  • Reuse endpoint constants and shared response helpers.
  • Keep handler response envelope consistent (code, data, message).
  • Ensure mock handlers reflect real API behavior and error semantics.
  • Keep naming stable for endpoint keys and mutation/query keys.

Do Not

  • Do not return ad-hoc response shapes for one-off convenience.
  • Do not bypass schema parsing in new client mutations/queries.
  • Do not mix unrelated domain endpoints in the same module.

Validation

  • Verify TypeScript and schema parsing paths compile cleanly.
  • Run: vp check --no-fmt