skills.rest
Shawn-Guo-CN
Shawn-Guo-CNCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST API patterns for resource naming, HTTP methods, and status codes.

Updated Feb 15, 2026
Search Tags:#documentation#api design#rest#backend development#web services#api patterns
One-click install
npx skills add https://github.com/Shawn-Guo-CN/agentfoundry-plugin-marketplace --skill api-design-shawn-guo-cn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Shawn-Guo-CN/agentfoundry-plugin-marketplace/tree/main/plugins/api-design
Command: npx skills add https://github.com/Shawn-Guo-CN/agentfoundry-plugin-marketplace --skill api-design-shawn-guo-cn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance and best practices for designing robust, scalable, and developer-friendly REST APIs, addressing common pitfalls and ensuring consistency.

Core Features & Use Cases

  • Resource Naming & URL Structure: Establishes conventions for clear and intuitive API endpoints.
  • HTTP Methods & Status Codes: Details the semantic use of HTTP verbs and appropriate status codes for various scenarios.
  • Response Formatting: Offers patterns for consistent success and error responses, including pagination.
  • Pagination, Filtering, Sorting: Provides strategies for efficient data retrieval and manipulation.
  • Authentication & Rate Limiting: Outlines secure authentication methods and rate limiting techniques.
  • Versioning: Recommends strategies for managing API evolution.
  • Use Case: When designing a new set of endpoints for a user management system, consult this Skill to ensure URLs are plural, HTTP methods are used correctly, and error responses are standardized.

Quick Start

Use the api-design skill to generate a standard JSON response structure for a paginated list of users.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for REST API resource naming and URL structure?▼

REST API resource naming requires clear, intuitive endpoint conventions using plural nouns. This ensures consistent, maintainable, and developer-friendly API contracts for production-grade web services.

How do I design REST API response formats for pagination and errors?▼

Design REST API response formats by standardizing JSON structures for both success and error payloads. Implement consistent pagination, filtering, and sorting patterns to ensure efficient data retrieval.

Which HTTP methods and status codes should I use for backend development?▼

Use HTTP methods and status codes semantically for backend development. Correct HTTP verbs define operations, while appropriate status codes communicate various scenarios, ensuring a robust REST API contract.

How do I implement authentication and rate limiting in web services?▼

Implement authentication and rate limiting in web services by applying secure authentication methods and rate limiting techniques. These established conventions protect REST APIs and manage traffic effectively.

When do I need API versioning strategies for production-ready REST APIs?▼

API versioning strategies are needed when managing REST API evolution to avoid breaking existing integrations. They recommend established conventions to maintain production-ready, developer-friendly web services.

Does this REST API design guidance require specific backend frameworks?▼

This REST API design guidance requires adherence to established conventions rather than specific backend frameworks. It provides patterns for HTTP methods, response formats, and versioning independent of platform dependencies.

Related Skills

Explore More Software Engineering Skills→
nicholasgriffintnnicholasgriffintn
2

backend-design

Plan backend systems, APIs, and data models with structured architecture decisions.

Community
Basic
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate
GaryOcean428GaryOcean428

api-design-validation

Validate REST API endpoint naming, HTTP methods, and status codes.

Community
Intermediate
act70255act70255

api-design-principles

Provide design principles and patterns for RESTful and GraphQL APIs.

Community
Advanced