Can it help me generate standard error codes?

Absolutely. It enforces standard response coverage for common scenarios like 422 Validation Failed, 429 Rate Limited, and 500 Internal Server Errors using RFC 7807 patterns.

Does it include support for multi-language code snippets?

Yes, it includes patterns for the x-codeSamples extension, allowing you to provide Shell, JavaScript, and Python examples directly in your documentation.

Does this skill support OpenAPI 3.1?

Yes, it is designed around modern OpenAPI 3.x standards to ensure full compatibility with documentation tools like Redoc and Swagger UI.

Why are realistic examples important for API docs?

Realistic examples enable better mock generation and easier integration testing for frontend developers compared to placeholder 'string' values.

How does this help with SDK generation?

By using proper string formats and named schemas instead of inline objects, it makes automatically generated SDKs significantly more type-safe and maintainable.

API Documentation Patterns

Name: API Documentation Patterns
Author: HermeticOrmus

byHermeticOrmus

0•

API 开发

Implements industry-standard OpenAPI best practices and documentation patterns for robust, developer-friendly API references.

This skill provides Claude with high-fidelity patterns for writing OpenAPI (OAS) specifications, focusing on clarity, type safety, and tool compatibility. It guides the generation of comprehensive operation summaries, detailed parameter schemas, realistic request/response examples, and standard error handling. By enforcing best practices like discriminator mapping and string format annotations, it ensures that your API documentation is not just readable by humans but also optimized for SDK generation, mock servers, and automated testing tools like Redocly and Spectral.

主要功能

01Realistic, test-ready example generation for complex request and response bodies

02Support for Redocly x-codeSamples extensions for multi-language code snippets

03Standardized OpenAPI operation and parameter documentation patterns

04Comprehensive HTTP response coverage including standard error and rate-limit codes

05Advanced schema features like discriminator mapping and specific string format validation

060 GitHub stars

使用场景

01Generating production-ready API documentation from technical requirements or backend code

02Refactoring messy Swagger/OpenAPI files into clean, standardized specifications

03Improving the developer experience (DX) by adding realistic examples and multi-language snippets

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/librecopy-claude-code api-doc-patterns

For use in Claude.ai and ChatGPT

主要功能

01Realistic, test-ready example generation for complex request and response bodies

02Support for Redocly x-codeSamples extensions for multi-language code snippets

03Standardized OpenAPI operation and parameter documentation patterns

04Comprehensive HTTP response coverage including standard error and rate-limit codes

05Advanced schema features like discriminator mapping and specific string format validation

060 GitHub stars

使用场景

01Generating production-ready API documentation from technical requirements or backend code

02Refactoring messy Swagger/OpenAPI files into clean, standardized specifications

03Improving the developer experience (DX) by adding realistic examples and multi-language snippets

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/librecopy-claude-code api-doc-patterns

For use in Claude.ai and ChatGPT