skills.rest
irahardianto
irahardiantoCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-documentation

Generate OpenAPI 3.1 specifications with endpoints, schemas, and examples.

150|48|Updated Jan 24, 2026
Search Tags:#error handling#openapi#developer experience#swagger#api documentation#api versioning#sdk generation
One-click install
npx skills add https://github.com/irahardianto/awesome-agv --skill api-documentation-irahardianto
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/irahardianto/awesome-agv/tree/main/.agents/skills/api-documentation
Command: npx skills add https://github.com/irahardianto/awesome-agv --skill api-documentation-irahardianto

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you produce accurate, developer-friendly API documentation that reduces integration errors and makes your endpoints easier to adopt and maintain.

Core Features & Use Cases

  • OpenAPI 3.1 specification authoring: Structure specs with clear info, paths, and components using reusable $ref patterns.
  • Request/response and error documentation: Include concrete examples and document every error response with codes and resolution guidance.
  • Versioning, migration, and deprecation clarity: Add changelogs, migration guides, and deprecation notices so teams can upgrade safely.

Use it when defining or updating REST APIs, generating SDK documentation, or publishing an interactive API portal pattern for faster client integration.

Quick Start

Use this skill when drafting a new OpenAPI 3.1 spec by asking: "Generate a complete OpenAPI 3.1 document for my Task API, including operationId, request/response examples, a standardized error schema, and a versioning + migration section."

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I document REST API endpoints with a complete error response catalog?▼

Documenting REST API endpoints requires defining clear paths, reusable schemas, and unique operationId values per endpoint. Include concrete request response examples and a complete error catalog with codes and resolution steps.

What's the best way to manage API versioning and migration in OpenAPI specifications?▼

API versioning and migration documentation requires explicit changelogs, migration guides, and deprecation notices. This ensures teams can upgrade safely and maintain consistent reusable components across versions.

What's the best way to manage API versioning and migration in OpenAPI specifications?▼

API versioning and migration documentation requires explicit changelogs, migration guides, and deprecation notices. This ensures teams can upgrade safely and maintain consistent reusable components across versions.

Does OpenAPI 3.1 support SDK generation guidance for developer integration?▼

OpenAPI 3.1 supports SDK generation by producing comprehensive specifications with structured endpoints, schemas, and examples. This improves developer integration and reduces support churn during client implementation.

Why does developer experience suffer when API documentation lacks standardized error schemas?▼

Developer experience suffers without standardized error schemas because integration errors increase. Documenting complete error response catalogs with codes and resolution steps reduces support churn and makes endpoints easier to adopt.

Why does developer experience suffer when API documentation lacks standardized error schemas?▼

Developer experience suffers without standardized error schemas because integration errors increase. Documenting complete error response catalogs with codes and resolution steps reduces support churn and makes endpoints easier to adopt.

Related Skills

Explore More Software Engineering Skills→
feasibleonefeasibleone
1

blong-rest

Implement REST APIs from OpenAPI specs within Blong's gateway.

Official
Intermediate
Jet-labsJet-labs

api-documenter

Generate OpenAPI 3.1+ and AsyncAPI specs with interactive documentation.

Official
Advanced
ntuan2502ntuan2502

api-documenter

Generate and validate OpenAPI 3.1 API documentation with Swagger UI and Redoc.

Community
Advanced
thesaifalitaithesaifalitai
8

api-designer

Design REST and GraphQL API architectures and generate OpenAPI 3.1 specifications.

Community
Advanced