skills.rest
hpsgd
hpsgdOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-design

Design RESTful API contracts with resource models, HTTP methods, and error handling.

Updated Apr 1, 2026
Search Tags:#security#rest#error-handling#endpoints#pagination#api-design
One-click install
npx skills add https://github.com/hpsgd/claude-marketplace --skill api-design-hpsgd
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/hpsgd/claude-marketplace/tree/main/plugins/engineering/architect/skills/api-design
Command: npx skills add https://github.com/hpsgd/claude-marketplace --skill api-design-hpsgd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing an API architecture that yields consistent, scalable interfaces and predictable behavior for developers.

Core Features & Use Cases

  • Define resource models, URL hierarchies, and HTTP methods that reflect ownership and lifecycle.
  • Establish robust error handling, pagination, and versioning to support evolving services.
  • Provide concrete examples across nested resources to guide implementation in real projects.

Quick Start

Create an API design for a domain by listing resources, endpoints, and payload schemas to generate a first-draft contract.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a RESTful API with proper resource modeling and URL hierarchy?▼

Design a RESTful API by defining resource models, URL hierarchies, and HTTP methods that reflect ownership and lifecycle. This approach yields consistent, scalable interfaces and predictable behavior for developers.

What is the best way to handle errors in REST API endpoints using standard patterns?▼

Handle REST API errors using RFC 9457 Problem Details semantics. This establishes robust error handling across nested resources, providing predictable behavior and consistent error responses for evolving services.

How do I structure pagination across nested resources in a scalable API?▼

Structure pagination across nested resources by applying pagination defaults and enforcing HTTP semantics. This creates a clean, scalable RESTful API architecture that supports complex resource retrieval.

Does REST API design support RFC 7396 Merge Patch for resource updates?▼

Yes, REST API design supports RFC 7396 Merge Patch semantics for resource updates. Enforcing these HTTP semantics alongside standard authentication patterns ensures consistent and predictable interface behavior.

How do I generate a first-draft API contract for a given domain?▼

Generate a first-draft API contract by listing resources, endpoints, and payload schemas for your domain. This process applies RESTful design principles to resource modeling and URL hierarchy to guide implementation.

Related Skills

Explore More Software Engineering Skills→
HechaoYannetHechaoYannet

create-architecture

Generate a master architecture document from GDDs, ADRs, and governance constraints.

Community
Advanced
aiyuekuangaiyuekuang
14

api-design

Design RESTful API structures with endpoints, schemas, and versioning.

Community
Advanced
ConradmakerConradmaker

be-api-design

Design REST API contracts with OpenAPI 3.1 schemas and RFC 7807 errors.

Community
Advanced
Himanshu040604Himanshu040604

api-design-principles

Guide RESTful and GraphQL API design with Python schema examples.

Community
Intermediate