skills.rest
thangvawn
thangvawnCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Guide RESTful API design covering resource naming, status codes, pagination, authentication, rate limiting, and versioning.

Updated Apr 6, 2026
Search Tags:#api design#rest api#pagination#status codes#http methods
One-click install
npx skills add https://github.com/thangvawn/agent_financial --skill api-design-thangvawn
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/thangvawn/agent_financial/tree/main/.cursor/.agents/skills/api-design
Command: npx skills add https://github.com/thangvawn/agent_financial --skill api-design-thangvawn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill unit provides a comprehensive guide to designing RESTful APIs, addressing common challenges and offering best practices for production APIs.

Core Features & Use Cases

  • Resource Naming: Learn the conventions for naming resources in URLs.
  • HTTP Methods and Status Codes: Understand the semantics and appropriate use of HTTP methods and status codes.
  • Pagination: Implement efficient pagination strategies for large datasets.
  • Authentication and Authorization: Explore token-based and role-based authentication patterns.
  • Rate Limiting: Implement rate limiting to protect your API from abuse.
  • Versioning: Learn strategies for API versioning to manage changes over time.
  • Implementation Patterns: Get examples of how to implement API endpoints in different programming languages.

Quick Start

Use the api-design skill to review your current API endpoints and improve their design following RESTful principles.

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 methods?▼

REST API design provides conventions for naming resources in URLs and semantics for HTTP methods. Following these best practices ensures standardized, predictable endpoints for production environments.

How do I implement pagination for large datasets in a REST API?▼

Implement REST API pagination by applying efficient strategies for large datasets. This skill provides guidelines to structure pagination patterns, ensuring clients can retrieve data chunks without overwhelming the server.

Which HTTP status codes should I return for different REST API operations?▼

HTTP status codes should match the semantics of your REST API operations. This skill outlines appropriate use cases for status codes, ensuring clients receive accurate response signals for successful or failed requests.

How do I add token-based authentication and rate limiting to a production API?▼

Add authentication and rate limiting to a production API by implementing token-based patterns and request thresholds. This skill provides guidelines to protect your endpoints from unauthorized access and abuse.

What is the best way to handle API versioning when managing changes over time?▼

API versioning manages changes over time by applying strategies that maintain backward compatibility. This skill outlines versioning patterns to help you evolve production APIs without breaking existing client integrations.

Does this REST API design guide include implementation patterns for different programming languages?▼

Yes, this REST API design guide includes implementation patterns demonstrating how to build endpoints in different programming languages. These examples help translate design principles directly into functional code.

Related Skills

Explore More Software Engineering Skills→
GalharelGalharel

frontend-designer-skill

Plan frontend architecture, stack selection, state management, and API integration from artifacts.

Community
Intermediate
HouseGarofaloHouseGarofalo
3

openapi-swagger

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

Official
Advanced
stackconsultstackconsult
2

nginx-production-infra

Configure Nginx reverse proxy with SSL, rate limiting, and load balancing.

Community
Advanced
iludeilude
8

api-design-patterns

Design REST and GraphQL APIs with language-agnostic patterns for routes, schemas, and specs.

Community
Advanced