skills.rest
datorresb
datorresbCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-documentation

Generate API documentation for REST, GraphQL, gRPC, and WebSocket APIs.

Updated Jan 23, 2026
Search Tags:#documentation#API#GraphQL#REST#WebSocket#examples#gRPC
One-click install
npx skills add https://github.com/datorresb/vibecoding-starter --skill api-documentation-datorresb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/datorresb/vibecoding-starter/tree/main/.claude/skills/documentation/api-documentation
Command: npx skills add https://github.com/datorresb/vibecoding-starter --skill api-documentation-datorresb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

APIs are products. Documentation is the user interface. Your API may be technically perfect, but without clear docs developers struggle to discover capabilities, integrate, and stay in sync with changes. This skill guides you to produce complete, developer-friendly API docs that reduce support load and speed adoption.

Core Features & Use Cases

  • Multi-paradigm coverage: REST, GraphQL, gRPC, and WebSocket APIs documented with consistent schemas, endpoints, and usage examples.
  • Structured templates: Standard sections for endpoints, authentication, errors, versioning, rate limits, and changelogs to keep docs aligned with implementation.
  • Maintenance workflows: Examples, inline code snippets, and testable docs that stay synchronized with code changes and releases.

Quick Start

Provide the API surface details (endpoints, schemas, auth flows, sample requests) and I will generate publication-ready documentation, including OpenAPI-compatible specs and multi-language usage examples.

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I generate API documentation for REST and GraphQL endpoints?▼

Generate API documentation by providing endpoint schemas, authentication flows, and sample requests to produce publication-ready docs with structured sections, consistent terminology, and multi-language usage examples for REST and GraphQL.

What's the best way to document WebSocket and gRPC APIs with consistent schemas?▼

Document WebSocket and gRPC APIs using structured templates that enforce consistent schemas, endpoints, error handling, and example-driven content, ensuring all API paradigms share uniform terminology and standardized sections.

Can I create OpenAPI or Swagger compatible specs from my existing API details?▼

Yes, you can create OpenAPI-compatible specs by providing your API surface details including endpoints, schemas, and auth flows to generate publication-ready documentation aligned with OpenAPI and Swagger standards.

How do I keep API documentation synchronized with code changes and releases?▼

Keep API documentation synchronized with code changes by using maintenance workflows that update inline code snippets, testable examples, and changelogs alongside versioned releases to ensure docs stay aligned with implementation.

Does this approach work for onboarding external teams with versioned API docs?▼

Yes, this approach works for onboarding external teams by generating complete, developer-friendly documentation with standardized sections for versioning, rate limits, and authentication flows that reduce support load and speed adoption.

What sections should API documentation include to cover authentication and error handling?▼

API documentation should include standard sections for endpoints, authentication flows, error handling, versioning, rate limits, and changelogs to ensure complete coverage and keep docs aligned with the actual implementation.

Related Skills

Explore More Software Engineering Skills→
OneWave-AIOneWave-AI
245

api-documentation-writer

Generate OpenAPI/Swagger specs and endpoint documentation for REST, GraphQL, WebSocket, and gRPC APIs.

Official
Basic
89jobrien89jobrien
4

documentation

Generate and maintain API documentation, OpenAPI specs, SDKs, and changelogs.

Community
Advanced
Spectaculous-CodeSpectaculous-Code

code-refactoring

Performs coordinated refactoring across multiple subsystemsGitHub codebase including frontend, backend, and Cucumber tests.

Official
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced