skills.rest
hzy970907
hzy970907COMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST APIs with resource naming, HTTP methods, and status codes.

23|7|Updated Feb 22, 2026
Search Tags:#best practices#documentation#api design#rest#web services#http
One-click install
npx skills add https://github.com/hzy970907/fish-claude-code --skill api-design-hzy970907
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/hzy970907/fish-claude-code/tree/main/skills/api-design
Command: npx skills add https://github.com/hzy970907/fish-claude-code --skill api-design-hzy970907

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 scalability.

Core Features & Use Cases

  • Resource Design: Establishes conventions for URL structure and naming.
  • HTTP Methods & Status Codes: Details the semantic use of HTTP methods and appropriate status codes for various scenarios.
  • Response Formatting: Defines standard structures for success, collection, and error responses.
  • Pagination, Filtering, Sorting: Implements scalable strategies for handling large datasets.
  • Authentication & Versioning: Covers secure authentication patterns and versioning strategies.
  • Use Case: When designing a new set of endpoints for a user management system, use this Skill to ensure all URLs, request/response formats, and error handling are consistent and follow industry best practices.

Quick Start

Follow the API design checklist to ensure all aspects of the new API endpoint are covered before deployment.

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 best practices establish consistent URL conventions by defining logical resource structures, standardizing endpoint paths, and ensuring maintainable web services design.

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

Implement REST API pagination and filtering by applying scalable strategies for handling large datasets, ensuring response payloads remain manageable and web services perform efficiently.

Which HTTP status codes should I use for different REST API scenarios?▼

Use appropriate HTTP status codes by following semantic guidelines that map various REST API scenarios, ensuring consistent communication of success, collection, and error responses.

What's the best way to handle authentication and rate limiting in web services?▼

Handle authentication and rate limiting in web services by applying secure authentication patterns and rate limiting strategies, ensuring REST APIs remain protected and scalable.

How do I structure error response formats for a production-ready REST API?▼

Structure REST API error response formats by defining standard structures that provide consistent, developer-friendly error details, ensuring maintainability across production-ready web services.

When should I implement versioning strategies in my REST API design?▼

Implement REST API versioning strategies when designing production-ready web services to manage breaking changes, ensuring consistent and scalable API development throughout the application lifecycle.

Related Skills

Explore More Software Engineering Skills→
is-ivanovis-ivanov
2

run-backend

Start the backend server using the repository's predefined launch script.

Community
Basic
GP-CRM-SystemGP-CRM-System

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from code and design inputs.

Official
Advanced
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
duylinhdang1998duylinhdang1998

graphql-expert

Design and implement type-safe GraphQL APIs with DataLoader batching and Relay pagination.

Community
Advanced