Documentation

What's new

Features shipped for builders, newest first. Click a card to expand details. The same list is under the bell icon in the header.

1. Preview

   NewSep 15, 2026

   Live sample UIs for Users, Posts, Auth, and every resource — create, edit, and delete against the real API.

   • Each resource docs page has a Preview button that opens a tiny app on top of the real endpoints.
   • List, search, paginate, create, edit, and delete rows — same shared demo database as everyone else.
   • Auth preview includes a working login form (password is always password) and GET /me with the token.
   • Use the header EN | FA toggle so preview lists load Persian sample data when you want it.

   Open Users preview →

2. Persian data (?lang=fa)

   Sep 14, 2026

   Get Iranian names, usernames, phones, and sample content by adding ?lang=fa to any endpoint.

   • English remains the default. Only the lang=fa query param switches text — no cookie or Accept-Language.
   • FA responses include Content-Language: fa and a font object pointing at Vazirmatn for rendering.
   • Works on list and detail routes, plus auth login with Persian overlay usernames.
   • In the Playground, picking FA in the header appends lang=fa for you.

   Language section →

3. Playground

   Sep 12, 2026

   Call live endpoints in the browser, try login success/fail, and inspect JSON responses.

   • Pick a resource and action, edit query params or JSON body, then send the request.
   • Auth login has Correct / Wrong password presets so you can demo 200 vs 401 quickly.
   • Responses show status, headers-friendly JSON, and pagination when the route returns it.
   • Handy for teaching, screenshots, and checking filters without opening Postman.

   Open Playground →

4. Mock Auth

   Sep 10, 2026

   POST /api/auth/login with any seeded username and password → get a Bearer token for /me.

   • Every seeded user shares the mock password: password.
   • Successful login returns a mock Bearer token and a user object (id, name, username, email, role).
   • Wrong password or unknown username returns 401 with a clear error payload.
   • Send Authorization: Bearer <token> to GET /api/auth/me to read the current user.

   Auth docs →

5. Live REST resources

   Sep 8, 2026

   Users, Posts, Comments, Albums, Photos, Todos, Products, Notifications, and Countries — full CRUD with pagination.

   • Standard list shape: { data, pagination } with page, limit, total, and totalPages.
   • Support for search, sort, filters, artificial delay, and forced error status query params.
   • Shared production database resets daily — great for demos, not for permanent storage.
   • Machine-readable catalog at /openapi.json for Postman, Swagger, and AI tools.

   Resources table →

Shared data

All visitors share the same live database. Creates, updates, and deletes are real and visible to everyone. On production, seed data resets automatically once per day via GET /api/cron/reset. Use this for prototyping and demos — not for storing anything you need to keep.

Language

All resource text is English by default. Pass lang=fa for Persian responses with Iranian names, usernames, emails, phones, and copy. No cookie or Accept-Language header is used — only the query param.

• Example: GET /api/users?lang=fa
• FA responses include Content-Language: fa and a font object (Vazirmatn) for rendering.
• Header EN | FA only adds ?lang=fa in the Playground.

1// Persian (Iranian) names & copy — English is default2const res = await fetch('/api/users?limit=3&lang=fa');3const { data, font } = await res.json();4// font.cssUrl → Vazirmatn stylesheet for Persian text5console.log(data, font);

1# Same with curl2curl "http://localhost:3000/api/users?limit=3&lang=fa"

Resources

Live endpoints you can call today, plus a short roadmap of what is next.

OpenAPI

Machine-readable catalog of every live endpoint (Auth, Users, Posts, Comments, Albums, Photos, Todos, Products, Notifications, Countries, and Admin reset). Import into Postman, Swagger UI, or AI tools.

1# Import into Postman / Insomnia / Swagger2curl -O http://localhost:3000/openapi.json

Requests

Lists return data + pagination. Single items return { data }.

1const res = await fetch('/api/posts?limit=6');2const { data, pagination } = await res.json();3console.log(data, pagination);

Persian: append lang=fa. See Language.

Errors

Failures use an error object. Statuses: 400 validation, 401 unauthorized, 404 missing, 429 rate limited, 500 server. Pass ?status=500 (400–599) to force an error for UI demos.

1{2  "error": {3    "code": "NOT_FOUND",4    "message": "Post not found"5  }6}

Rate limit

All /api/* routes allow about 60 requests per IP per minute. Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. Over limit returns 429 with Retry-After.

1{2  "error": {3    "code": "RATE_LIMITED",4    "message": "Too many requests. Try again in 42s."5  }6}

Reset seed

For an immediate reset, use the panel below with the admin secret. Production also resets automatically once per day (Shared data).