api-designer

Design and review RESTful APIs against OpenAPI 3.x specifications.

2|1|Updated Feb 27, 2026

Search Tags:#api design #openapi #rest #endpoint design #api conventions #api review

Ready to run

npx skills add https://github.com/Kaakati/sdh-claude-skills --skill api-designer-kaakati

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/Kaakati/sdh-claude-skills/tree/main/.claude/skills/api-designer
Command: npx skills add https://github.com/Kaakati/sdh-claude-skills --skill api-designer-kaakati

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of designing and reviewing REST APIs, ensuring consistency, adherence to standards, and a positive developer experience.

Core Features & Use Cases

API Design: Define resources, operations, and URL structures following REST conventions.
Schema Definition: Create clear request and response schemas with examples.
Error Handling: Implement standardized error formats and HTTP status codes.
Use Case: When tasked with creating a new API for user management, use this skill to define the endpoints for creating, retrieving, updating, and deleting users, along with their request/response formats and error codes.

Quick Start

Use the api-designer skill to design the API for a new e-commerce product catalog.

Frequently Asked Questions about api-designer

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

FAQPage Schema

How do I design REST APIs for consistency and developer experience?▼

To design REST APIs for consistency, define resource identification, URL structures, and request/response schemas. Standardize error handling, pagination, filtering, and versioning to ensure a positive developer experience.

What are the best practices for OpenAPI 3.x endpoint design?▼

OpenAPI 3.x endpoint design best practices include adhering to REST conventions for resource operations, creating clear schemas with examples, and implementing standardized error formats and HTTP status codes.

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

Review a REST API for standards compliance by checking its resource identification, URL structure, error handling, pagination, filtering, sorting, and versioning against OpenAPI 3.x specifications and best practices.

How should I structure error handling and HTTP status codes in my API?▼

Structure API error handling by implementing standardized error formats and appropriate HTTP status codes. This ensures consistent REST API responses and improves overall developer experience.

Does this API design approach support pagination and filtering conventions?▼

Yes, this API design approach supports pagination and filtering conventions. It covers these query parameters alongside sorting and versioning to ensure comprehensive REST API standards compliance.