Can I use this to improve an existing API?

Absolutely. The skill is designed to help with refactoring existing architectures by identifying inconsistent naming, incorrect status codes, or poor nesting structures.

What frameworks are supported by this skill?

The core REST principles provided are language-agnostic, though it includes specific implementation examples for popular frameworks like Express.js to demonstrate real-world usage.

What does the REST API Design skill help with?

It provides a standardized framework for designing consistent, scalable, and intuitive RESTful APIs, covering everything from resource naming to error handling patterns.

Does this skill support OpenAPI documentation?

Yes, it includes specific instructions and templates for creating OpenAPI 3.0 specifications to ensure your API is properly documented and discoverable.

REST API Design Guide

Name: REST API Design Guide
Author: aj-geddes

byaj-geddes

•

API Development

Designs intuitive, industry-standard RESTful APIs using best practices for resource modeling, HTTP status codes, and documentation.

This skill equips Claude with specialized knowledge to architect robust RESTful APIs that follow industry-leading standards. It provides comprehensive guidance on resource-oriented naming, the correct application of HTTP methods and status codes, implementation of pagination and filtering, and secure versioning strategies. Whether you are building a new backend from scratch or refactoring an existing service, this skill ensures your API remains consistent, scalable, and developer-friendly by emphasizing resource-oriented architecture and clear response structures.

Key Features

01Standardized resource-oriented naming conventions using plural nouns

02Precise HTTP method mapping for CRUD operations and nested resources

03Detailed status code mapping for success, client errors, and server issues

04Structured response formats for collections, pagination, and error handling

0518 GitHub stars

06Comprehensive OpenAPI/Swagger documentation templates and versioning strategies

Use Cases

01Refactoring an inconsistent legacy API to meet modern REST standards

02Designing a new microservice API architecture from scratch

03Generating comprehensive OpenAPI specifications for existing backend services

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add aj-geddes/useful-ai-prompts rest-api-design

For use in Claude.ai and ChatGPT

Download Skill