api-design

Design REST API endpoints with consistent naming, methods, statuses, and pagination.

4|Updated Mar 21, 2026
One-click install
npx skills add https://github.com/Yog-Sotho/claude-skills --skill api-design-yog-sotho
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Yog-Sotho/claude-skills/tree/main/api-design
Command: npx skills add https://github.com/Yog-Sotho/claude-skills --skill api-design-yog-sotho

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

REST API design is error-prone and inconsistent without a shared pattern; this skill guides your team to apply standardized naming, methods, status codes, versioning, pagination, and security practices to deliver scalable, maintainable APIs.

Core Features & Use Cases

  • Design patterns for resource naming, HTTP methods, status codes, and versioning.
  • Pagination, filtering, error handling, rate limiting, idempotency, and security considerations across public and partner APIs.
  • Real-world workflows and examples for transforming design decisions into OpenAPI specs and implementable code across TypeScript, Python, and Go stacks.

Quick Start

Describe your API endpoint design and Claude will generate a complete REST design blueprint.

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 with consistent naming, methods, and status codes?

Designing a REST API with consistent naming, methods, and status codes requires applying standardized resource patterns and HTTP conventions. This skill generates a complete REST design blueprint, ensuring endpoints follow uniform naming, correct methods, and appropriate status codes across public and internal APIs.

What is the best way to handle pagination, filtering, and error handling in REST APIs?

Handling pagination, filtering, and error handling in REST APIs involves implementing standardized data retrieval patterns and robust error responses. This skill provides design patterns for pagination, data filtering, and comprehensive error handling to ensure scalable and maintainable API architectures.

How do I generate OpenAPI specifications from my API design decisions?

Generating OpenAPI specifications from API design decisions involves transforming endpoint patterns into standardized documentation. This skill aligns your REST API deliverables with OpenAPI specs, translating naming, methods, and security decisions into implementable specs across TypeScript, Python, and Go stacks.

Can I use this to design security and versioning patterns for public and partner APIs?

Yes, you can use this to design security and versioning patterns for public and partner APIs. This skill applies security considerations, rate limiting, idempotency, and versioning practices to deliver robust APIs, adapting the design patterns to your specific tech stack and API exposure context.

Does this skill support designing REST APIs for TypeScript, Python, and Go stacks?

Yes, this skill supports designing REST APIs for TypeScript, Python, and Go stacks. It provides real-world workflows and examples that transform your design decisions into implementable code, ensuring the API design adapts effectively to your specific development environment.

When should I deprecate API endpoints and how do I manage deprecation timelines?

Deprecating API endpoints and managing deprecation timelines requires aligning deliverables with comprehensive documentation standards. This skill ensures your REST API design includes structured deprecation timelines and documentation, maintaining consistency and safety throughout the API lifecycle.