Skills
.Work. You
Rest

rest-api-architect

Community

Standardize REST API design across languages.

Software Engineering#openapi#conventions#error-handling#pagination#api-design#rest-api#http-standards
Authorralvarezdev
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Cross-language REST conventions — resource URLs, method semantics, status codes, URL-prefix versioning, cursor pagination, snake_case JSON, ISO 8601 timestamps, RFC 7807 errors, Idempotency-Key, ETag/If-Match, OpenAPI as source of truth. Framework-agnostic. Use when designing or auditing REST endpoints.

Core Features & Use Cases

  • URL & resource design: Placing IDs in paths, snake_case in URLs, and nested resources with clear hierarchy.
  • HTTP semantics & versioning: Correct method usage, status codes, and URL-prefix versioning per RFCs.
  • Error contracts & security: RFC 7807 problem details, rate-limiting headers, and openAPI-driven contracts.
  • Idempotency & concurrency: Idempotency-Key for POST/PATCH and ETag/If-Match for optimistic concurrency.
  • OpenAPI as truth: Ensure API contracts are defined in OpenAPI 3.1 and source-of-truth for clients and docs.

Quick Start

Review your REST endpoints against the conventions defined in this skill and align designs to the OpenAPI specification.

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-architect
Download link: https://github.com/ralvarezdev/ralvaskills/archive/main.zip#rest-api-architect

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 510,000+ vetted skills library on demand.