skills.rest
theodrosyimer
theodrosyimerCOMMUNITY
Explore all skills by this author →
GitHub

api-docs

Generate a browsable API documentation website from an OpenAPI specification.

1|Updated Jan 13, 2023
Search Tags:#documentation#api#openapi#scaffold#nextjs#fumadocs
One-click install
npx skills add https://github.com/theodrosyimer/.dotfiles --skill api-docs-theodrosyimer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/theodrosyimer/.dotfiles/tree/main/claude/skills/dev__api-docs
Command: npx skills add https://github.com/theodrosyimer/.dotfiles --skill api-docs-theodrosyimer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires fumadocs-openapi, tsx, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Developers need a fast way to create a fully functional, production‑ready API documentation site from an OpenAPI specification without manually building the Next.js project.

Core Features & Use Cases

  • Scaffold a Next.js app with Fumadocs UI, Tailwind CSS and MDX support.
  • Generate static MDX pages for each API operation directly from the spec.
  • Customize brand colors, site title, and code sample languages.
  • Ideal for building developer portals, API reference guides, or internal documentation sites.

Quick Start

Run the scaffold script with your OpenAPI file to generate the documentation site.

Frequently Asked Questions about api-docs

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

FAQPage Schema
How do I generate an API documentation site from an OpenAPI spec?▼

You can generate an API documentation site by running a scaffold script that creates a Next.js app with Fumadocs UI and static MDX pages directly from your OpenAPI JSON or YAML file.

What do I need to create a developer portal from an OpenAPI file?▼

To create a developer portal from an OpenAPI file, you need a valid OpenAPI JSON or YAML specification and a Node.js environment with npm or pnpm installed to run the scaffold script.

Can I customize the API reference site generated from my OpenAPI specification?▼

Yes, you can customize the generated API reference site by configuring brand colors, site title, and code sample languages within the scaffolded Next.js and Tailwind CSS project.

Does this API docs generator work with both JSON and YAML OpenAPI formats?▼

Yes, this API docs generator works with both JSON and YAML OpenAPI formats, parsing the specification to produce browsable static MDX pages for each API operation.

What is the best way to build a browsable API reference for REST services?▼

The best way to build a browsable API reference for REST services is scaffolding a Next.js project with Fumadocs UI, which generates static MDX pages for each API operation directly from your OpenAPI spec.

Related Skills

Explore More Software Engineering Skills→
CrazyDubyaCrazyDubya

api-documentation-generator

Generate OpenAPI 3.0 documentation from API route definitions in code.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
idealjsidealjs
5

create-component-nextjs-page

Create Next.js MDX/TSX component demo pages with variants and visual regression tests.

Official
Intermediate
dt418dt418

Docs Pack

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

Community
Intermediate