skills.rest
ZacharyLuz
ZacharyLuzCOMMUNITY
Explore all skills by this author →
GitHub

api-documentation

Generate structured API documentation from OpenAPI, GraphQL, and proto schemas.

5|2|Updated Jan 13, 2026
Search Tags:#documentation#API#GraphQL#REST#WebSocket#gRPC
One-click install
npx skills add https://github.com/ZacharyLuz/github-copilot-chat-exporter --skill api-documentation-zacharyluz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/ZacharyLuz/github-copilot-chat-exporter/tree/main/.claude/skills/documentation/api-documentation
Command: npx skills add https://github.com/ZacharyLuz/github-copilot-chat-exporter --skill api-documentation-zacharyluz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams convert API specifications into accurate, developer-friendly documentation that stays in sync with implementation.

Core Features & Use Cases

  • REST API Documentation: Generate comprehensive endpoint references including paths, parameters, headers, responses, and examples.
  • GraphQL Documentation: Document schemas, queries, mutations, and authentication flows with clear usage examples.
  • gRPC & Protobuf Documentation: Describe services, messages, and streaming patterns with practical implementations.
  • WebSocket Documentation: Outline connection models, message formats, and lifecycle events for real-time APIs.
  • Use Case: When launching a new API, create a complete OpenAPI/Swagger and related docs from schemas and protos, ensuring consistency across teams.

Quick Start

Provide the API specification (OpenAPI, GraphQL schema, or proto definitions) and request a structured, publish-ready documentation draft outlining endpoints, data models, auth, and 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 from OpenAPI and GraphQL schemas?▼

To generate API documentation, provide your OpenAPI, GraphQL schema, or proto definitions to automatically create publish-ready drafts detailing endpoints, data models, authentication, and examples.

Can I document gRPC and WebSocket connection models automatically?▼

Yes, you can automatically document gRPC services, messages, and streaming patterns, alongside WebSocket connection models, message formats, and lifecycle events for real-time APIs.

What is the best way to keep API docs synchronized with schema implementations?▼

Keeping API docs synchronized involves automatically generating and updating your documentation as your REST, GraphQL, gRPC, or WebSocket schemas evolve across development and release workflows.

Does this API documentation approach work for both REST and GraphQL protocols?▼

Yes, this API documentation approach works for both REST and GraphQL protocols, generating comprehensive endpoint references and documenting schemas, queries, mutations, and authentication flows.

What do I need to start documenting REST API endpoints and authentication details?▼

You need to provide your API specification, such as OpenAPI definitions, to generate a structured documentation draft outlining endpoints, parameters, headers, responses, and authentication details.

Related Skills

Explore More Software Engineering Skills→
nahisahonahisaho
69

api-designer

Design RESTful, GraphQL, and gRPC APIs with OpenAPI and Protobuf definitions.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
EsellersEGEsellersEG

shopify-admin

Generate and validate GraphQL queries and mutations for the Shopify Admin API.

Community
Advanced
akillnessakillness
40

api-documentation

Generate API documentation from OpenAPI specs or code annotations.

Community
Advanced