skills.rest
medride
medrideOFFICIAL
Explore all skills by this author →
GitHub

api-design

Design resource-oriented APIs with standard methods, versioning, and error handling.

1|1|Updated Jan 15, 2026
Search Tags:#design#versioning#api#openapi#patterns#pagination#resource-oriented
One-click install
npx skills add https://github.com/medride/claude-code-research --skill api-design-medride
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/medride/claude-code-research/tree/main/.claude/skills/api-design
Command: npx skills add https://github.com/medride/claude-code-research --skill api-design-medride

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Patterns and guidelines for designing consistent, scalable APIs using resource-oriented design, inspired by API Design Patterns and Google API Improvement Proposals (AIP).

Core Features & Use Cases

  • Standardizes resource naming and structuring for clear, predictable APIs.
  • Provides guidance for pagination, field masks, versioning, error handling, and security schemas.
  • Includes templates and examples (OpenAPI template and a task-management API) to accelerate design work.

Quick Start

Create a clean, resource-oriented API design for a task-management system following the patterns described in this skill.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is resource-oriented API design and when should I use it?▼

Resource-oriented API design models APIs as nouns-based resources with clear hierarchies and standard methods. Use it to build predictable, scalable services requiring consistent pagination, field masks, and robust error handling.

How do I design an API with pagination, field masks, and batch operations?▼

Design APIs with pagination, field masks, and batch operations by applying resource-oriented patterns from API Design Patterns and Google AIP to standardize resource naming, structuring, and method behaviors for scalable services.

Does this API design approach support OpenAPI specifications and security schemas?▼

Yes, this API design approach supports OpenAPI specifications by providing templates for security schemas, versioning, and error handling, ensuring clear resource hierarchies and standardized methods are properly documented.

What is the best way to version APIs and handle errors in scalable services?▼

The best way to version APIs and handle errors in scalable services is following Google AIP and resource-oriented patterns, which provide structured guidance for standardizing versioning, error responses, and security schemas.

Can I use these API design patterns for a task-management system?▼

Yes, you can use these API design patterns for a task-management system. The skill includes a specific template and example demonstrating how to create a clean, resource-oriented API for task-management workflows.

Related Skills

Explore More Software Engineering Skills→
mattstrublemattstruble
2

api-design

Design and review AEP-compliant REST/gRPC APIs with resource modeling and standard methods.

Community
Advanced
cornmanwtfcornmanwtf

openapi-code-generator

Generate typed API clients, server stubs, validators, and documentation from OpenAPI specifications.

Community
Intermediate
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
HeldinhowHeldinhow
4

graphql-api

Design GraphQL schemas, resolvers, and DataLoader-based performance optimizations.

Community
Intermediate