Can I use this for GraphQL or gRPC?

While it includes guidance for choosing between protocols, its primary implementation patterns are optimized for RESTful architecture.

Does this skill support OpenAPI 3.0?

Yes, it encourages an OpenAPI-first approach, helping you write and validate specifications before or during the coding process.

Does it provide a standard error format?

Yes, it implements a structured JSON error format including codes, messages, and field-level validation details for better client-side handling.

How does it handle API versioning?

It promotes URL versioning (like /v1/ or /v2/) and provides rules for handling breaking changes and deprecation notices.

Will it help me fix RPC-style endpoints?

Yes, the skill is designed to identify and correct anti-patterns like /getUser or /createOrder, converting them into standard RESTful resource paths.

API Design & OpenAPI Standards

Name: API Design & OpenAPI Standards
Author: phrazzld

byphrazzld

•

API Development

Enforces REST-first principles and OpenAPI-driven documentation to build scalable, backward-compatible backend services.

The API Design skill empowers Claude to architect professional-grade interfaces by following strict RESTful principles, using resources as nouns and HTTP methods as verbs. It streamlines the creation of OpenAPI specifications, ensures consistent HTTP status code usage, and implements standardized error formats and pagination logic. By focusing on an 'OpenAPI-first' workflow and providing clear versioning strategies, this skill helps developers avoid common RPC-style anti-patterns and maintain high-quality documentation that stays in sync with implementation.

Key Features

01Consistent pagination and sorting implementation patterns

02OpenAPI 3.0 specification generation and validation

03URL-based API versioning and deprecation strategies

04RESTful resource-oriented architecture enforcement

052 GitHub stars

06Standardized HTTP status code and error response mapping

Use Cases

01Generating comprehensive OpenAPI documentation for existing backend services

02Architecting a new RESTful microservice from the ground up

03Refactoring RPC-style legacy endpoints into standardized REST resources

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add phrazzld/claude-config api-design

For use in Claude.ai and ChatGPT

Download Skill