api-design

Standardize REST API naming, HTTP semantics, pagination, and versioning rules.

Updated Mar 18, 2026

Search Tags:#versioning #security #rest #pagination #api-design #http-status

Ready to run

npx skills add https://github.com/ignidus/iscagent --skill api-design-ignidus

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design patterns establish consistent conventions for naming, response formats, and versioning to reduce ambiguity and drift across services.

Core Features & Use Cases

Naming conventions for resources and endpoints.
HTTP method semantics, status codes, pagination, and error handling.
Versioning and security guidelines for production APIs.

Quick Start

Review an existing API contract and apply the naming, status codes, pagination, and versioning guidelines.

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 naming conventions and endpoint structures?▼

REST API naming conventions standardize resource endpoints to reduce ambiguity and drift across services. Applying consistent naming rules ensures predictable resource identification and simplifies endpoint creation during API design reviews.

What HTTP status codes and error handling schemas should I use for REST APIs?▼

HTTP status codes and error handling schemas provide semantic communication for REST API responses. Standardizing these codes and error structures enforces consistent HTTP method semantics and predictable error handling across services.

What is the best way to implement pagination and rate-limiting in a REST API?▼

Pagination and rate-limiting practices manage payload size and traffic volume in REST APIs. Enforcing these production guidelines during endpoint creation ensures scalable resource retrieval and protects services from excessive request loads.

How do I plan REST API versioning and security guidelines across services?▼

REST API versioning and security guidelines prevent breaking changes and enforce access control across services. Planning versioning rules and security practices during API design reviews establishes stable production contracts and mitigates drift.

How do I review an existing API contract for REST compliance?▼

Reviewing an existing API contract for REST compliance involves applying standardized naming, status codes, pagination, and versioning guidelines. This process identifies convention drift and enforces consistent HTTP semantics and error handling schemas.