Skip to main content

API Design Specification

Pro

Design RESTful or GraphQL APIs with endpoints, schemas, auth, error handling, and pagination

Template Fields

Service / DomaintextRequired

e.g., User management, E-commerce orders, Content publishing, IoT device control

API StyleselectRequired
RESTGraphQLgRPCREST + WebSocket
Key OperationsmultilineRequired

List the main things the API should do, e.g.: - Create/read/update/delete users - Upload files - Search with filters - Real-time notifications

AuthenticationselectRequired
JWT Bearer tokenAPI keyOAuth 2.0Session-basedNone (public)
API ConsumersmultiselectRequired
Web frontend (SPA)Mobile appThird-party developersInternal microservicesCLI tools
Expected Scaleselect
Low (< 100 req/min)Medium (100-1000 req/min)High (1000+ req/min)Massive (10K+ req/min)
Use This Template

This is a Pro template. Upgrade to access.

Related Templates

Bug Report

Write a clear, actionable bug report that developers can act on immediately

README Generator

Create a professional README.md for any project or repository

API Endpoint Documentation

Document an API endpoint with request/response examples

Git Commit Message

Write clear, conventional commit messages with proper scope and description