api-design

Name: api-design
Availability: InStock
Author: Sean

Standardize REST API design with resource naming, status codes, and pagination.

Updated Apr 21, 2026

Search Tags:#versioning #documentation #rest #http #error-handling #pagination #api-design

Ready to run

npx skills add https://github.com/SeanChenR/ghibli --skill api-design-seanchenr

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/SeanChenR/ghibli/tree/main/.claude/skills/api-design
Command: npx skills add https://github.com/SeanChenR/ghibli --skill api-design-seanchenr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardize REST API design for reliability by enforcing consistent resource naming, status codes, pagination, and error handling across services.

Core Features & Use Cases

Resource URL naming conventions
HTTP method semantics and status codes
Pagination strategies (cursor and offset)
Filtering, sorting, and search patterns
Versioning, deprecation, and error response formats
Authentication patterns and documentation guidelines

Quick Start

Design a new endpoint /api/v1/users using kebab-case naming, correct HTTP methods, and semantic status codes.

Frequently Asked Questions about api-design

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

FAQPage Schema

How do I standardize REST API design for reliability across new endpoints?▼

You standardize REST API design for reliability by enforcing consistent resource URL naming, correct HTTP method semantics, and cohesive documentation standards across all new endpoints. This ensures predictable service behavior and clear integration contracts.

What are the best practices for REST API pagination and filtering?▼

Best practices for REST API pagination and filtering involve implementing both cursor and offset pagination strategies alongside standardized sorting and search patterns. This allows efficient data retrieval without overloading the service.

How should I format error responses and handle status codes in HTTP APIs?▼

You format error responses and handle status codes in HTTP APIs by enforcing semantic HTTP status codes and standardized error response formats. This provides clients with actionable feedback and maintains consistent API behavior.

How do I implement API versioning and deprecation for existing contracts?▼

You implement API versioning and deprecation for existing contracts by applying standardized versioning rules to your resource URLs and documenting deprecation timelines. This allows safe service evolution without breaking existing client integrations.

Does this approach work for auditing existing REST API contracts?▼

Yes, this REST API standardization approach works for auditing existing contracts by validating them against enforced resource naming conventions, authentication patterns, and error formatting rules to identify inconsistencies and improve reliability.