Sintra AI
Home
Live Feed
Automation Hub
Prompt Library256
AI News554
Weekly Digest
Topic Hubs
AI History
AI Labs
Research
Learning Paths
Guides
Resources
Concepts
Videos
AI Tools74
Models
Claude
Google AI
Cost Calc
Back to Sintra/Code & Automation
intermediate·Code & Automation·15 min

Design a REST API

A complete REST API spec with endpoints, schemas, auth, error codes, and design recommendations.

✓ high confidenceverified 2026-05-30
⬡
Recommended modelClaude Sonnet 4.6

Top SWE-bench score; precise multi-file reasoning

What you need to fill in

[describe what the product or feature does][who will call this API][list the main data objects]

Tools used

ClaudeChatGPT

The prompt

Design a RESTful API for the following use case. Product/feature description: [describe what the product or feature does] Target consumers: [who will call this API — mobile app, web frontend, third-party partners?] Core entities: [list the main data objects, e.g., User, Order, Product] Deliver a complete API design including: 1. Resource hierarchy and all endpoints (method + path + one-line description) 2. Request/response JSON schemas for each endpoint (use realistic field names and types) 3. Authentication mechanism (JWT, API key, OAuth2 — recommend what fits best and explain why) 4. Pagination strategy for list endpoints 5. Standard error response format with HTTP status codes (400, 401, 403, 404, 409, 422, 500) 6. Versioning strategy (URL prefix vs. header) 7. Rate limiting recommendation 8. Three potential design pitfalls to watch out for in this specific API Format the endpoint list as a Markdown table.
Open in Claude

Try with these tools

claudechatgpt
api-designrestbackendarchitecture

More in Code & Automation

Write Unit Tests

A complete runnable test file with happy-path, edge-case, and error tests covering 90%+ of branches.

intermediate

Code Review Checklist

A structured review report with categorized issues, risk levels, and actionable fix suggestions.

intermediate

Debug This Error

Plain-English explanation of the error, ranked root causes, a concrete code fix, and prevention tips.

beginner