Skills
.Work. You
Rest

doc-api-md

Community

Generate API documentation in Markdown.

Software Engineering#technical writing#rest api#api documentation#api specification#markdown generator#toc api#server api
Authorhokix
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill streamlines the creation of API documentation by providing standardized Markdown templates for both client-facing (toC) and server-to-server APIs.

Core Features & Use Cases

  • Standardized Templates: Generates documentation using predefined structures for domains, endpoints, request/response schemas, and authentication.
  • API Type Support: Differentiates between toC (mobile/web) and server interfaces.
  • Use Case: A developer needs to document a new REST API endpoint. They provide the endpoint details, and the Skill generates a well-formatted Markdown document ready for inclusion in a project's documentation.

Quick Start

Use the doc-api-md skill to generate documentation for a new toC API endpoint.

Dependency Matrix

Required Modules

None required

Components

assets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-api-md
Download link: https://github.com/hokix/dotfiles/archive/main.zip#doc-api-md

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.