skills.rest
KuaaMU
KuaaMUCOMMUNITY
Explore all skills by this author →
𝕏@X_SwarmMindGitHub

api-design

Guide REST API design covering naming, methods, status codes, and versioning.

4|Updated Feb 14, 2026
Search Tags:#best practices#web development#api design#backend#rest#guidelines
One-click install
npx skills add https://github.com/KuaaMU/omnihive --skill api-design-kuaamu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/KuaaMU/omnihive/tree/main/library/ecc-skills/api-design
Command: npx skills add https://github.com/KuaaMU/omnihive --skill api-design-kuaamu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidelines and best practices for designing consistent, developer-friendly REST APIs, ensuring maintainability and ease of integration.

Core Features & Use Cases

  • Resource Naming Conventions: Standardizes URL structures for clarity and predictability.
  • HTTP Method Semantics: Ensures correct usage of GET, POST, PUT, PATCH, DELETE.
  • Status Code Guidance: Recommends appropriate HTTP status codes for various scenarios.
  • Response Formatting: Defines clear structures for success and error responses, including pagination.
  • Pagination Strategies: Details offset-based and cursor-based pagination.
  • Filtering, Sorting, and Search: Provides patterns for querying collections.
  • Authentication & Authorization: Outlines token-based auth and authorization patterns.
  • Rate Limiting: Explains rate limiting headers and tiers.
  • Versioning: Recommends URL path versioning and deprecation strategies.
  • Implementation Examples: Offers code snippets in TypeScript, Python, and Go.

Quick Start

Use the api-design skill to generate a REST API design for a user resource, including pagination and error handling.

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 HTTP method semantics?▼

REST API design best practices involve standardizing URL structures for resource predictability and correctly applying GET, POST, PUT, PATCH, and DELETE methods to ensure clear, maintainable API contracts.

How do I implement pagination, filtering, and sorting for REST API collections?▼

Implement REST API collection querying using offset-based or cursor-based pagination strategies, alongside defined patterns for filtering and sorting, to manage large datasets efficiently and maintain response performance.

Which HTTP status codes and response formats should I use for REST API errors?▼

REST API error handling requires recommending appropriate HTTP status codes for various scenarios and defining clear, consistent response formats that structure error details for developer-friendly integration.

How do I handle authentication, authorization, and rate limiting in a scalable REST API?▼

Scalable REST APIs handle security by outlining token-based authentication, defining authorization patterns, and explaining rate limiting headers and tiers to control traffic and protect backend resources.

Can I find REST API design guidelines with implementation examples in TypeScript, Python, and Go?▼

Yes, comprehensive REST API design guidelines provide implementation examples in TypeScript, Python, and Go, helping establish consistent, production-ready API contracts across multiple backend environments.

When should I use URL path versioning and deprecation strategies for web APIs?▼

URL path versioning and deprecation strategies are needed when evolving REST APIs to introduce breaking changes without disrupting existing clients, ensuring maintainability and clear migration paths for developers.

Related Skills

Explore More Software Engineering Skills→
rohanbhatia27rohanbhatia27
1

devcontainer-setup

Automate Docker and VS Code Dev Container creation for Python, Node/TypeScript, Rust, and Go projects.

Community
Advanced
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
mduongvandinhmduongvandinh
6

gateway-service

Route and secure microservice API traffic with JWT validation and Redis rate limiting.

Community
Advanced
efekrbasefekrbas
41

api-design-principles

Design REST and GraphQL API contracts with typed schemas and consistent status codes.

Community
Advanced