api-design

Design REST API contracts with endpoint naming, status codes, and versioning.

2|Updated Jul 1, 2026
One-click install
npx skills add https://github.com/CDO-07-New/TF4-AIO-03-foresight-lens-final --skill api-design-cdo-07-new
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/CDO-07-New/TF4-AIO-03-foresight-lens-final/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/CDO-07-New/TF4-AIO-03-foresight-lens-final --skill api-design-cdo-07-new

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you design clear, production-ready REST APIs with consistent resources, status codes, and response shapes so clients can integrate reliably.

Core Features & Use Cases

  • Resource design: Plan plural, kebab-case endpoints and sub-resources that map cleanly to CRUD and action-based operations.
  • API behavior standards: Choose correct HTTP methods, status codes, pagination styles, filtering, sorting, and rate limiting.
  • Error and versioning patterns: Define structured error responses, authentication and authorization rules, and a stable versioning strategy for evolving APIs.
  • Use case: Use it when reviewing a new endpoint set for a web platform, tightening an internal service contract, or documenting partner-facing API behavior.

Quick Start

Ask for a production REST API design review for your endpoint list and have the Skill return recommended URLs, methods, status codes, error formats, and versioning guidance.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is the best way to structure REST API endpoints for consistent resource design?

REST API resource design should use plural, kebab-case URLs and sub-resources that map cleanly to CRUD operations. This approach ensures endpoint naming is predictable and clients can integrate with your production services reliably.

How do I implement structured error handling and versioning for a production REST API?

Implement structured error handling by defining standardized error response envelopes for your REST API. For versioning, establish a stable strategy that allows endpoints to evolve predictably without breaking existing client integrations.

Can I use this to design pagination, filtering, and rate limiting for partner-facing APIs?

Yes, you can design predictable pagination styles, filtering, sorting, and rate limiting for public, partner, and internal APIs. It provides behavior standards to ensure your API contracts remain consistent across different access levels.

How do I choose the correct HTTP methods and status codes for my REST API operations?

Choose HTTP methods and status codes by applying semantic HTTP usage to resource-oriented URLs. This ensures your REST API returns accurate responses for both standard CRUD and action-based operations across your service.

When do I need to define authentication and authorization rules for REST API endpoints?

You need to define authentication and authorization rules whenever designing production REST APIs. Establishing these security boundaries ensures that access to your endpoints is properly controlled across public, partner, and internal API contexts.