How does this skill help with resource-oriented design?

It provides specific patterns to transform action-oriented endpoints into resource-oriented nouns, ensuring your API follows standard REST conventions for better predictability.

Can this skill assist with API security?

It covers essential security patterns including JWT Bearer tokens, API keys, rate limiting headers, and CORS configuration to protect your endpoints from unauthorized access and abuse.

Which pagination method does this skill recommend?

The skill provides guidance on Offset-based, Cursor-based, and Link Header pagination, helping you choose the right approach based on your dataset size and real-time requirements.

Does it include error handling standards?

Yes, it provides a standardized JSON error response format including error codes, messages, and validation details to ensure consistent client-side handling.

REST API Design

Name: REST API Design
Author: karchtho

bykarchtho

0•

API 开发

Architects intuitive, scalable, and standardized RESTful web services using industry-best practices for resource modeling and HTTP semantics.

This skill provides a comprehensive framework for designing and implementing production-grade REST APIs that are developer-friendly and maintainable. It guides users through resource-oriented architecture, ensuring endpoints represent nouns rather than actions, and strictly adheres to HTTP method semantics and status code standards. From planning advanced pagination and filtering strategies to implementing secure versioning and idempotency, this skill serves as an expert consultant for building APIs that stand the test of time and scale effectively across distributed systems.

主要功能

01Standardized HTTP method semantics and idempotent operation patterns

02Resource-oriented URL modeling and pluralization naming conventions

03Advanced pagination strategies including cursor-based and Link headers

040 GitHub stars

05API versioning, rate limiting, and OpenAPI documentation best practices

06Comprehensive HTTP status code mapping for success and error states

使用场景

01Designing a new microservice API from scratch with consistent resource hierarchies

02Refactoring legacy endpoints to align with modern RESTful standards and better UX

03Establishing team-wide API design guidelines and performing automated spec reviews

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add karchtho/my-claude-marketplace rest-api-design

For use in Claude.ai and ChatGPT

Download Skill