skills.rest
Miles0sage
Miles0sageCOMMUNITY
Explore all skills by this author →
GitHub

api-design-patterns

Define RESTful HTTP API patterns for URL structure, versioning, pagination, and authentication.

Updated Aug 23, 2026
Search Tags:#versioning#authentication#api design#openapi#rest#http
One-click install
npx skills add https://github.com/Miles0sage/claude-ultimate-stack --skill api-design-patterns-miles0sage
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-patterns
Source: https://github.com/Miles0sage/claude-ultimate-stack/tree/main/skills/api-design-patterns
Command: npx skills add https://github.com/Miles0sage/claude-ultimate-stack --skill api-design-patterns-miles0sage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive set of best practices and patterns for designing consistent, developer-friendly HTTP APIs, addressing common challenges in API development.

Core Features & Use Cases

  • URL Structure & Conventions: Defines clear rules for resource naming and URL design.
  • Versioning Strategies: Outlines recommended approaches for API versioning.
  • Response Envelopes: Standardizes success and error response formats for clarity.
  • Pagination: Implements both cursor-based and offset-based pagination.
  • Authentication: Details JWT and OAuth 2.0 implementation patterns.
  • OpenAPI Specification: Guides the creation of machine-readable API definitions.
  • Use Case: When designing a new microservice API, use this Skill to ensure all endpoints follow consistent naming conventions, implement secure authentication, and provide clear, paginated responses with proper error handling.

Quick Start

Use the api-design-patterns skill to generate an OpenAPI specification for a new user management API.

Frequently Asked Questions about api-design-patterns

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

FAQPage Schema
What is the best way to structure REST API URLs and endpoints?▼

The best way to structure REST API URLs is by defining clear rules for resource naming and URL design to ensure endpoints remain consistent and developer-friendly across distributed systems.

How do I implement JWT and OAuth 2.0 authentication in an HTTP API?▼

To implement API authentication, apply detailed JWT and OAuth 2.0 patterns to secure your HTTP endpoints, ensuring maintainable and safe access control across your distributed services.

Should I use cursor-based or offset-based pagination for my API?▼

API pagination should use cursor-based or offset-based approaches depending on dataset scale, standardizing how response payloads handle large collections to maintain performance and consistency.

How do I generate an OpenAPI specification for a new microservice?▼

You can generate an OpenAPI specification by applying these API design patterns to define machine-readable API definitions, ensuring your new microservice follows standard conventions and secure authentication.

What are the recommended strategies for HTTP API versioning?▼

Recommended API versioning strategies involve outlining specific approaches to manage endpoint changes over time, ensuring backward compatibility and consistent maintainability across distributed systems.

Related Skills

Explore More Software Engineering Skills→
deepnoodle-aideepnoodle-ai

http-api-design

Design ergonomic JSON HTTP APIs with OpenAPI 3.1 specifications.

Official
Advanced
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
dreadnodedreadnode
11

jxscout-repeater

Automate raw HTTP request sending and track timestamped request/response pairs.

Official
Intermediate
nahisahonahisaho
69

api-designer

Design RESTful, GraphQL, and gRPC APIs with OpenAPI and Protobuf definitions.

Community
Intermediate