api-design

Standardize REST API resource naming, HTTP methods, status codes, and versioning.

Updated Sep 13, 2025
One-click install
npx skills add https://github.com/Sambalicious/express-typescript-starter --skill api-design-sambalicious
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Sambalicious/express-typescript-starter/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/Sambalicious/express-typescript-starter --skill api-design-sambalicious

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design inconsistencies across services create integration friction, slow development, and increase maintenance costs.

Core Features & Use Cases

  • Standardized resource naming and URL conventions.
  • Pagination, filtering, and sorting guidance with practical examples.
  • Consistent HTTP methods, status codes, and error responses.
  • Versioning strategy and deprecation guidelines to manage API lifecycles.

Quick Start

Define a production-ready REST API design for a new service, applying consistent naming, pagination, and error handling.

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 endpoints for a new service?

To design consistent REST API endpoints, apply standardized resource naming and URL conventions to resolve integration friction. This ensures production-ready APIs use proper HTTP methods, clear pagination, and uniform error handling across services.

What is the best way to handle REST API error responses and HTTP status codes?

The best way to handle REST API error responses is to enforce consistent HTTP methods and standardized status codes. This approach provides clear error responses, reducing integration friction and slowing development across services.

How do I implement pagination and filtering in a REST API?

Implement pagination and filtering in a REST API by following standardized patterns with practical examples. This enforces consistent resource naming and URL conventions, providing clear guidance for production APIs.

When do I need a versioning strategy for my REST API?

You need a versioning strategy for your REST API to manage the API lifecycle and provide deprecation guidelines. This resolves design inconsistencies, reduces maintenance costs, and ensures stable service integration over time.

Why do REST API design inconsistencies create integration friction?

REST API design inconsistencies create integration friction because varying resource naming, pagination, and error handling patterns slow development. Standardizing these elements resolves misalignment and significantly reduces maintenance costs.

Does this REST API design approach work for reviewing existing API contracts?

Yes, this REST API design approach works for reviewing existing API contracts by resolving inconsistencies. It enforces standardized patterns for resource naming, HTTP methods, and error responses to align production APIs.