Agent skill · software engineering · aiskillstore
designing-apis
Designs REST and GraphQL APIs including endpoints, error handling, versioning, and documentation. Use when creating new APIs, designing endpoints, reviewing API contracts, or when asked about REST, GraphQL, or API patterns.
Why this skill is useful
Provides specific patterns and examples for designing REST and GraphQL APIs that the AI wouldn't reliably generate on its own.
What it needs
About 3k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Designing APIs When to Load Trigger: Designing REST or GraphQL endpoints, API contracts, versioning, request/response formats Skip: Internal-only code with no API surface API Design Workflow Copy this checklist and track progress: REST API Design URL Structure HTTP Status Codes Code Meaning Use Case ---- ----------------- -------------------------- 200 OK Successful GET, PUT, PATCH 201 Created Successful POST 204 No Content Successful DELETE 400 Bad Request Invalid input 401 Unauthorized Missing/invalid auth 403 Forbidden Valid auth, no permission 404 Not Found Resource doesn't exist 409 Conflict Duplicate, state conflict 422 Unprocessable Validation failed 429 Too Many Requests Rate limited 500 Internal Error Server error Response Formats Success Response: List Response with Pagination: Error Response: API Versioning URL Versioning (Recommended): Header Versioning: Authentication Patterns JWT Bearer Token: API Key: Rate Limiting Headers GraphQL Patterns Schema Design: OpenAPI Specification Template See OPENAPI-TEMPLATE.md for the full OpenAPI 3.0 specification template. API Design Validation After completing the design, validate against this checklist: If validation fails, return to the relevant design step and address the issues. Security Checklist [ ] HTTPS only [ ] Authentication on all endpoints [ ] Authorization checks [ ] Input validation [ ] Rate limiting [ ] Request size limits [ ] CORS properly configured [ ] No sensitive data in URLs [ ] Audit logging
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/designing-apis