skills.rest
luongldptit
luongldptitCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Standardize REST API resource naming, status codes, pagination, and error formatting.

Updated Mar 26, 2026
Search Tags:#error handling#api design#rate limiting#rest api#pagination#api versioning#http methods
One-click install
npx skills add https://github.com/luongldptit/move-ticket --skill api-design-luongldptit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/luongldptit/move-ticket/tree/main/.agent/.agents/skills/api-design
Command: npx skills add https://github.com/luongldptit/move-ticket --skill api-design-luongldptit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the common pain of building inconsistent, hard-to-integrate REST APIs that lead to poor developer experience, integration bugs, and unexpected production behavior.

Core Features & Use Cases

  • Standardized API Conventions: Covers resource naming, HTTP method semantics, status code usage, and response formatting for consistent endpoints.
  • Scalable Pattern Support: Includes best practices for pagination, filtering, sorting, error handling, versioning, and rate limiting for both small and large-scale APIs.
  • Use Case: When building a public e-commerce API, use this Skill to ensure all product, order, and user endpoints follow consistent naming, return proper 4xx error codes for invalid requests, and implement cursor-based pagination for high-volume product listings.

Quick Start

Use the api-design skill to review your existing user endpoint structure and validate it against REST best practices for naming, status codes, and error responses.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design consistent REST API resource naming and HTTP status codes?▼

Designing consistent REST APIs requires standardized resource naming, semantic HTTP method usage, and proper status codes. Applying proven design patterns ensures endpoints remain predictable, which eliminates integration friction and improves developer experience.

What is the best way to implement pagination and filtering for high-volume REST APIs?▼

Implementing pagination and filtering for REST APIs relies on scalable patterns like cursor-based pagination. This approach handles high-volume product listings efficiently while maintaining consistent response formatting across both small and large-scale services.

How should I format error handling responses in a REST API?▼

Error handling in REST APIs needs standardized error formatting and proper 4xx status codes for invalid requests. Consistent error response structures prevent integration bugs and unexpected production behavior during client implementations.

Can I use this REST API design approach for internal partner services?▼

Yes, this REST API design approach applies to public, partner, and internal services. It validates existing endpoint structures against REST best practices, ensuring consistent naming, versioning, and rate limiting across all service tiers.

Why does my REST API cause integration friction for developers?▼

REST APIs cause integration friction when implementations lack consistent conventions for versioning, rate limiting, and error formatting. Applying standardized design patterns to contract reviews and implementation tasks eliminates these poor developer experiences.

Related Skills

Explore More Software Engineering Skills→
cwinvestmentscwinvestments
412

memstack-development-api-designer

Generate Next.js App Router API routes with authentication guards and Zod validation.

Community
Advanced
petbrainspetbrains
13

backend-trpc-openapi

Generate REST endpoints and OpenAPI documentation from tRPC routers.

Official
Intermediate
thapaliyabikendrathapaliyabikendra
24

api-design-principles

Apply REST API design principles to API contracts and specifications.

Community
Basic
asalhamedasalhamed

api-designer

Design REST, GraphQL, and gRPC API contracts with versioning and error formats.

Community
Advanced