api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

39|2|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/hffmnnj/opencode-goopspec --skill api-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/hffmnnj/opencode-goopspec/tree/main/skills/api-docs
Command: npx skills add https://github.com/hffmnnj/opencode-goopspec --skill api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill streamlines the creation of accurate, developer-focused API documentation from codebases and OpenAPI/GraphQL specifications, reducing manual drafting and mismatches.

Core Features & Use Cases

  • Documentation generation: Generate API reference docs from OpenAPI specs, GraphQL schemas, and annotated source code.
  • Versioned docs: Produce versioned endpoints and change logs to support API deprecation and upgrades.
  • Use Case: A team needs up-to-date docs for a REST service with dozens of endpoints. This skill generates the endpoint summaries, parameter lists, response schemas, and code examples in multiple languages.

Quick Start

Use the api-docs skill to generate a documentation set from your OpenAPI spec and GraphQL schema.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate API documentation from an OpenAPI specification?

Generate API documentation automatically by parsing your OpenAPI spec to extract endpoint summaries, parameters, response schemas, and examples. The skill processes your spec file and outputs comprehensive reference docs in multiple formats, eliminating manual drafting and reducing documentation drift from code changes.

Can I create versioned API documentation that tracks deprecations and changes?

Yes, versioned documentation is supported. The skill produces separate endpoint references and changelogs for each API version, allowing you to maintain accurate docs across deprecations, upgrades, and breaking changes while keeping historical versions accessible to users.

Does this work with GraphQL APIs as well as REST?

Documentation generation works with both REST APIs via OpenAPI specs and GraphQL APIs via schema definitions. The skill parses both specification types to produce consistent, developer-focused reference docs with the same accuracy and coverage across API paradigms.

What input files do I need to generate documentation?

Provide OpenAPI/Swagger definitions for REST APIs or GraphQL schema files for GraphQL services. The skill also parses annotated source code to extract additional context. These inputs are required to generate accurate endpoint summaries, parameter documentation, and request/response examples.

Can I generate code examples in multiple languages?

Yes, the skill produces code examples in multiple programming languages alongside your API documentation. Examples are generated from your endpoint definitions and schemas, giving developers practical snippets for REST and GraphQL integration across their tech stack.

What's the best way to keep API documentation in sync with code changes?

Automate documentation generation from your source specs and code annotations. By regenerating docs whenever your OpenAPI spec or GraphQL schema updates, you eliminate manual maintenance and ensure documentation always reflects your current API definition and endpoints.