Skills
.Work. You
Rest

rest-api-guidelines

Community

Opinionated REST API design guidance.

Software Engineering#versioning#error-handling#pagination#api-design#rest-api#design-guidelines#http-methods
Authortommymorgan
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Opinionated REST API design guidance to reduce inconsistency and miscommunication when building, reviewing, and evolving web APIs across teams and services.

Core Features & Use Cases

  • URL Structure: promotes stable, readable, and versioned resource paths.
  • HTTP Methods & Semantics: enforces safe and idempotent operations and proper status handling.
  • Error Formats & Status Codes: standardizes error payloads and codes for predictable client behavior.
  • Pagination, Filtering, Sorting: specifies consistent paging and query semantics.
  • Versioning & Naming Conventions: provides clear version strategies and property naming rules.
  • Cross-Origin & Security Considerations: outlines CORS and auth guidance to secure APIs.
  • Real-world Scenarios: guides API planning, reviews, and design reviews during development cycles.

Quick Start

Consult these guidelines at the start of a new API project to align on REST conventions.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: rest-api-guidelines
Download link: https://github.com/tommymorgan/claude-plugins/archive/main.zip#rest-api-guidelines

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.