api-design

A collection of patterns for designing API route handlers, including a shared success and error response shape and recommended HTTP status codes. An API route is a server endpoint that receives requests and returns data.

In plain words
What is it for?
Use it when building GET, POST, PATCH, or DELETE routes that authenticate users, access data, and return consistent responses.
Why use it?
It keeps endpoints predictable for clients and makes common outcomes such as authentication failures, validation errors, and missing records clear.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/vibestackdev/vibe-stack/api-design
Clone the repo
git clone --depth 1 https://github.com/vibestackdev/vibe-stack

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 303 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00303
Opus 5 $0.00000 $0.00151
Sonnet 5 $0.00000 $0.00061
Haiku 4.5 $0.00000 $0.00030

Measured yesterday against content hash 9c6d1dda49d0, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

api-design scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/api-design.mdc · 43 lines

What it actually says

API Design Patterns

Standard response format for Route Handlers: Success: { data: T, error: null } Error: { data: null, error: { code: string, message: string } }

HTTP status codes:

  • 200: Success (GET, PATCH)
  • 201: Created (POST)
  • 204: No content (DELETE)
  • 400: Validation error
  • 401: Unauthenticated
  • 403: Unauthorized
  • 404: Not found
  • 500: Server error

Route handler template:

import { NextResponse } from 'next/server'
import { createServerClient } from '@supabase/ssr'

export async function GET(request: Request, { params }: { params: Promise<{ id: string }> }) {
  const { id } = await params
  const supabase = createServerClient(...)
  
  const { data: { user } } = await supabase.auth.getUser()
  if (!user) {
    return NextResponse.json(
      { data: null, error: { code: 'UNAUTHORIZED', message: 'Login required' } }, 
      { status: 401 }
    )
  }
  
  // ... fetch data
  return NextResponse.json({ data: { id, status: 'ok' }, error: null })
}
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 43 lines · 0 tokens per session scan A 9c6d1dda49d0

Subscribe to this mod's changes

api-design is a cursor rule published in the GitHub repository vibestackdev/vibe-stack (7 stars, last pushed 2d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 303 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.