skills.rest
zircote
zircoteCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-documentation

Review OpenAPI and AsyncAPI specifications for documentation completeness and quality.

3|1|Updated Jan 17, 2026
Search Tags:#openapi#asyncapi#swagger#documentation-review#api-documentation#api-patterns
One-click install
npx skills add https://github.com/zircote/documentation-review --skill api-documentation-zircote
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/zircote/documentation-review/tree/main/skills/api-documentation
Command: npx skills add https://github.com/zircote/documentation-review --skill api-documentation-zircote

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

API documentation often lacks consistency, completeness, and accessible guidance across OpenAPI, AsyncAPI, and related formats; this skill provides structured templates and review guidance to help teams produce accurate, navigable API docs.

Core Features & Use Cases

  • OpenAPI/AsyncAPI coverage patterns and templates for endpoints, schemas, and authentication.
  • Review workflows and quality checklists to ensure completeness, accuracy, and usability.
  • Portal-ready outputs and conversion guidance for Swagger UI, ReDoc, and Stoplight.

Quick Start

Draft a complete OpenAPI specification for a REST API and generate accompanying API documentation templates.

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I improve OpenAPI documentation quality and consistency?▼

To improve OpenAPI documentation quality, apply structured templates and review workflows that ensure frontmatter presence, align with OpenAPI 3.x patterns, and verify endpoint, schema, and authentication completeness.

What's the best way to generate AsyncAPI documentation templates?▼

Generating AsyncAPI documentation templates involves using structured coverage patterns that define event-driven schemas, authentication, and messaging protocols to ensure navigable and accurate API docs.

Can I use Swagger UI and ReDoc with OpenAPI specifications?▼

Yes, you can integrate OpenAPI specifications with portal tools like Swagger UI, ReDoc, and Stoplight by using conversion guidance to produce portal-ready outputs for accessible API documentation.

How do I review an API specification for completeness?▼

Reviewing an API specification for completeness requires running through quality checklists that verify frontmatter presence, validate endpoint and schema coverage, and ensure alignment with OpenAPI 3.x patterns.

Does this approach work for both REST and AsyncAPI documentation?▼

Yes, this approach works for both REST and AsyncAPI documentation by applying structured templates and review workflows tailored to each format's specific patterns and coverage requirements.

Related Skills

Explore More Software Engineering Skills→
VeradelaCruzVeradelaCruz

api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Community
Intermediate
epieczkoepieczko

api.validate

Validate OpenAPI 3.x and AsyncAPI 3.x specifications against Zalando guidelines.

Community
Intermediate
deepeshBodhdeepeshBodh
35

patterns-api-contracts

Design RESTful API contracts and generate OpenAPI 3.x specifications with error schemas.

Community
Advanced
DexploarerDexploarer
7

api-documentation-generator

Generate OpenAPI specifications from code annotations and existing endpoints.

Community
Advanced