OpenAPI Patterns

Author OpenAPI 3.x specifications with schema design and RFC 7807 error handling.

Updated Feb 25, 2026

Search Tags:#best practices #documentation #api design #openapi #specification #rest api

Ready to run

npx skills add https://github.com/HermeticOrmus/LibreCopy-Claude-Code --skill openapi-patterns

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: OpenAPI Patterns
Source: https://github.com/HermeticOrmus/LibreCopy-Claude-Code/tree/main/plugins/api-documentation/skills/openapi-patterns
Command: npx skills add https://github.com/HermeticOrmus/LibreCopy-Claude-Code --skill openapi-patterns

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive knowledge base and best practices for writing correct, consistent, and developer-friendly OpenAPI 3.x specifications, improving API design and documentation quality.

Core Features & Use Cases

Best Practices: Offers guidelines on resource naming, HTTP method semantics, and schema design patterns.
Pattern Examples: Demonstrates common patterns like polymorphism, read/write schemas, and pagination envelopes.
Error Handling: Details the RFC 7807 Problem Details standard for consistent error responses.
Authentication: Covers various authentication schemes (API Key, Bearer Token, OAuth2).
Use Case: A developer is tasked with designing a new REST API. They can consult this Skill to ensure their OpenAPI specification follows industry best practices, leading to a more maintainable and understandable API.

Quick Start

Use the OpenAPI Patterns skill to learn about best practices for resource naming conventions in API specifications.

Frequently Asked Questions about OpenAPI Patterns

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

FAQPage Schema

What are the best practices for REST API resource naming conventions in OpenAPI specifications?▼

REST API resource naming conventions in OpenAPI specifications require using plural nouns for collections and consistent naming patterns. This Skill provides guidelines on resource naming, HTTP method semantics, and schema design patterns to ensure robust and maintainable API documentation.

How do I design error handling patterns for an OpenAPI 3.x specification?▼

Designing error handling patterns for an OpenAPI 3.x specification is best done using the RFC 7807 Problem Details standard. This Skill details the RFC 7807 standard to help developers create consistent and standardized error responses across their REST APIs.

What is the best way to structure authentication schemes in an OpenAPI specification?▼

Structuring authentication schemes in an OpenAPI specification involves defining security schemes like API Key, Bearer Token, and OAuth2. This Skill covers these various authentication schemes to help you secure your REST API consistently.

How do I implement schema design patterns like polymorphism and pagination in OpenAPI?▼

Implementing schema design patterns like polymorphism and pagination in OpenAPI involves using specific schema structures for read/write operations and pagination envelopes. This Skill demonstrates these common pattern examples to guide your API design.

Does this OpenAPI best practices knowledge base support REST API documentation for beginners?▼

This OpenAPI best practices knowledge base supports REST API documentation for beginners by providing a comprehensive knowledge base covering schema design and naming conventions. It aids developers in creating robust, consistent, and developer-friendly API documentation.