skills.rest
nimadorostkar
nimadorostkarCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Standardize HTTP API design with OpenAPI 3.1 and RFC 9457 error payloads.

25|3|Updated Jul 14, 2026
Search Tags:#versioning#api#openapi#backend#rest#http
One-click install
npx skills add https://github.com/nimadorostkar/Claude-Skills-collection --skill api-design-nimadorostkar
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/nimadorostkar/Claude-Skills-collection/tree/main/skills/backend/api-design
Command: npx skills add https://github.com/nimadorostkar/Claude-Skills-collection --skill api-design-nimadorostkar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill addresses the common pitfalls in API development, such as inconsistent status codes, poor resource modeling, and breaking changes that frustrate client developers.

Core Features & Use Cases

  • Resource Modeling: Provides a framework for designing RESTful endpoints that prioritize resources over procedures.
  • Standardization: Ensures consistent error handling using RFC 9457 and proper status code semantics.
  • Evolution: Guides the implementation of versioning and deprecation strategies to ensure long-term API stability.

Quick Start

Use the api-design skill to review my current endpoint definitions and suggest improvements for resource naming 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 RESTful APIs that follow OpenAPI 3.1 specifications?▼

To design RESTful APIs with OpenAPI 3.1, you should enforce resource-oriented modeling over procedures and use consistent error payloads. This standardizes endpoint creation and ensures your HTTP interfaces remain standard-compliant.

What is the best way to handle HTTP API versioning and deprecation?▼

HTTP API versioning and deprecation requires a structured evolution strategy to prevent breaking changes. Implementing dedicated versioning guidelines ensures long-term API stability and clearly communicates transition timelines to client developers.

How do I standardize error handling in HTTP APIs using RFC 9457?▼

Standardizing HTTP API error handling with RFC 9457 involves applying problem details for all client-facing interfaces. This enforces consistent error payloads and proper status code semantics across your endpoints.

Can I audit existing API contracts for resource modeling and status code consistency?▼

You can audit existing API contracts by reviewing endpoint definitions against resource-oriented modeling and error payload standards. This process identifies inconsistent status codes and poor resource modeling to suggest targeted improvements.

Why does my API design suffer from breaking changes and poor resource modeling?▼

API design suffers from breaking changes and poor resource modeling due to inconsistent development practices. Applying a standardized review process with resource prioritization and strict error handling mitigates these common pitfalls.

Related Skills

Explore More Software Engineering Skills→
rabbicserabbicse

api-designer

Design REST and GraphQL API contracts as OpenAPI 3.1 specifications.

Community
Advanced
parhummparhumm
25

backend-api-contract

Generate OpenAPI 3.1 contracts from API resource entities, PRDs, or database schemas.

Community
Advanced
KotlinKotlin
14

error-model-validation-architect

Define machine-readable API error contracts for Kotlin and Spring services.

Official
Advanced
yusufcmgyusufcmg
1

api-design-principles

Guide REST and GraphQL API design with patterns and best practices.

Community
Intermediate