skills.rest
JayRHa
JayRHaCOMMUNITY
Explore all skills by this author →
Website𝕏@jannik_reinhardGitHub

api-docs-writer

Generates Markdown API reference pages and validated OpenAPI 3.1 specifications from routes, controllers and live endpoints.

3|2|Updated Jun 9, 2026
Search Tags:#documentation#markdown#api#openapi#codegen#docs
One-click install
npx skills add https://github.com/JayRHa/AgentSkills --skill api-docs-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs-writer
Source: https://github.com/JayRHa/AgentSkills/tree/main/api-docs-writer
Command: npx skills add https://github.com/JayRHa/AgentSkills --skill api-docs-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API teams struggle to create accurate, maintainable API references and OpenAPI specs from scattered sources.

Core Features & Use Cases

  • Generates production-grade endpoint reference pages (Markdown) and a validated OpenAPI 3.1 spec.
  • Aggregates source from routes, controllers, and live responses to ensure accuracy.
  • Supports code samples, parameter tables, authentication, pagination, and error tables for docs portals.

Quick Start

Provide your API source (routes, specs, or live responses) and let the tool generate complete API documentation.

Frequently Asked Questions about api-docs-writer

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

FAQPage Schema
How do I generate API documentation from existing code and routes?▼

Generate API documentation by providing your source routes, controllers, or live responses as input. The tool aggregates these sources to produce accurate endpoint reference pages and validated OpenAPI 3.1 specifications.

Can I create an OpenAPI 3.1 specification from live API endpoints?▼

Yes, you can create an OpenAPI 3.1 specification from live API endpoints. The tool aggregates live responses alongside code and routes to generate validated specs and ensure documentation accuracy.

What is the best way to document API pagination and error tables for a developer portal?▼

Document API pagination and error tables by generating Markdown reference pages from your API source. The tool specifically supports creating parameter tables, authentication details, and error tables for developer portals.

Does this API documentation generator support Markdown output for product docs portals?▼

Yes, this API documentation generator supports Markdown output. It produces production-grade Markdown endpoint reference pages specifically designed for integration into product docs portals and internal API documentation.

How to generate code samples and parameter schemas for API reference documentation?▼

Generate code samples and parameter schemas by feeding your API routes or specs into the tool. It automatically extracts and formats endpoint summaries, parameter schemas, and authentication details into reference documentation.

Related Skills

Explore More Content & Communication Skills→
pnppnp
842

api-docs-generator

Generate structured Markdown API references from source code, OpenAPI specs, or route definitions.

Official
Intermediate
LLLLimboLLLLimbo

openapi-spec-generation

Generate and maintain OpenAPI 3.1 specifications from code and design-first inputs.

Community
Intermediate
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate