skills.rest
tgautier
tgautierCOMMUNITY
Explore all skills by this author →
Website𝕏@_tgautierGitHub

api-design

Design and review REST API contracts with OpenAPI alignment.

2|1|Updated Jun 30, 2019
Search Tags:#versioning#openapi#rest#error-handling#pagination#api-design#http-semantics
One-click install
npx skills add https://github.com/tgautier/dotfiles --skill api-design-tgautier
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/tgautier/dotfiles/tree/main/claude/skills/api-design
Command: npx skills add https://github.com/tgautier/dotfiles --skill api-design-tgautier

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Language-agnostic REST API design guidance for production-grade APIs. Covers resource design, HTTP semantics, status codes, error formatting (RFC 9457), pagination, filtering, versioning, idempotency, authentication, authorization, security headers, caching, developer experience, resilience, and OpenAPI standards. Use cases include designing new endpoints, reviewing API contracts, or making HTTP semantics decisions.

Core Features & Use Cases

  • Resource design and URL conventions
  • HTTP methods, status codes, and error formats per RFC 9457
  • Pagination, filtering, and sorting
  • Versioning strategies and lifecycle management
  • Authentication, authorization, and security considerations
  • OpenAPI alignment and developer experience

Quick Start

Design and review a REST API contract by applying the design principles and generating an OpenAPI specification.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API with consistent HTTP semantics and standardized errors?▼

REST API pagination and filtering are implemented by applying consistent URL conventions and query parameters. Establishing these patterns ensures efficient data retrieval and scalable endpoint contracts across services.

What is the best way to handle API versioning and lifecycle management?▼

REST API security and authentication are enforced by implementing authorization protocols and applying security headers. Managing these considerations protects endpoints and ensures controlled access to resources.

How do I generate an OpenAPI specification from my REST API design?▼

You generate an OpenAPI specification by reviewing your REST API contract against resource-oriented design principles. Aligning your endpoints with OpenAPI standards ensures developer experience and contract consistency.

Does REST API design guidance support idempotency and caching mechanisms?▼

Yes, REST API design guidance supports idempotency and caching mechanisms. Applying these HTTP semantics improves network resilience and optimizes response times for repeated endpoint requests.

Related Skills

Explore More Software Engineering Skills→
alexfalkowskialexfalkowski
2

api-standards

Enforce resource-oriented API design and transport-specific conventions for gRPC, REST, and MVC contracts.

Community
Advanced
belokonmbelokonm
8

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
deepnoodle-aideepnoodle-ai

http-api-design

Design ergonomic JSON HTTP APIs with OpenAPI 3.1 specifications.

Official
Advanced
yusufcmgyusufcmg
1

api-design-principles

Guide REST and GraphQL API design with patterns and best practices.

Community
Intermediate