skills.rest
kalilurrahman
kalilurrahmanCOMMUNITY
Explore all skills by this author →
Website𝕏@krahmanGitHub

api-design

Designs REST or GraphQL API specifications with endpoints, schemas, authentication, and error handling.

1|Updated Mar 21, 2026
Search Tags:#authentication#error handling#api design#openapi#rest#graphql#endpoints
One-click install
npx skills add https://github.com/kalilurrahman/kr-claudiator-skills-original-prompts --skill api-design-kalilurrahman
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/kalilurrahman/kr-claudiator-skills-original-prompts/tree/main/01-software-dev/api-design
Command: npx skills add https://github.com/kalilurrahman/kr-claudiator-skills-original-prompts --skill api-design-kalilurrahman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Turning vague product requirements into a complete, unambiguous API specification is slow and error-prone, often leaving engineers to guess at endpoints, error codes, and authentication flows. ## Core Features & Use Cases - Endpoint and Schema Design: Maps resources to HTTP methods and paths (REST) or queries and mutations (GraphQL), with full request/response schemas. - Error Handling and Auth Planning: Defines machine-readable error codes, HTTP status mappings, OAuth 2.0 flows, rate limits, and versioning strategy. - Use Case: Given requirements for a user management service, produce a complete spec covering GET/POST /users endpoints, validation errors, pagination, and rate limit headers, then export it as an OpenAPI 3.0 YAML file. ## Quick Start Ask the AI to design a REST API for your resources and operations, and have it save the result as an OpenAPI 3.0 specification.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API from product requirements?▼

Start by identifying resources and operations, then map them to HTTP methods and paths using plural nouns like /users. Define request and response schemas, error codes, authentication, and pagination, then save the result as an OpenAPI 3.0 YAML file.

REST vs GraphQL: which API style should I choose?▼

Choose REST for resource-oriented operations with clear CRUD patterns, and GraphQL when clients need flexible, complex data fetching across related entities. gRPC is the better fit for internal service-to-service communication.

What should an API error response format include?▼

An error response should include a machine-readable code, a human-readable message, the offending field, and optional details. Pair each code with the correct HTTP status, such as 400 for validation errors and 409 for conflicts.

How do I add rate limiting to a public API?▼

Define per-user limits such as 1000 requests per hour with a burst allowance, and return X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers so clients can throttle themselves.

When should I version my API and how?▼

Use URL-based versioning like /v1/ and introduce a new version only for breaking changes. Non-breaking additions such as new optional fields stay in the current version, with a deprecation notice period before sunset.

Related Skills

Explore More Software Engineering Skills→
gabriellstgabriellst
4

prd

Generate a structured PRD.md document from product ideas or feature descriptions.

Community
Intermediate
UnicornUnicorn

api-design-agent

Design API contracts and documentation for RESTful and GraphQL services.

Official
Intermediate
constellizeconstellize
1

write-integration-tests

Write end-to-end integration tests validating contracts and data flows with real dependencies.

Official
Advanced
majiayu000majiayu000
258

api-design

Design API contracts for REST, GraphQL, and gRPC contexts.

Community
Advanced