Apidoc

Use this skill when the user wants to generate interactive REST API documentation from inline code annotations.

javimosch Updated 57 repo stars

File contents

apiDoc Plugin

apiDoc generates API docs from source code annotations.

Usage Examples

  • "generate API docs from source code"
  • "serve API documentation locally for review"
  • "compare API versions between releases"
  • "generate docs with custom template"

Installation

npm install -g apidoc

Key Features

  • Inline annotation documentation
  • REST API endpoint generation
  • Request/response example display
  • Parameter and type documentation
  • Version comparison between releases
  • Custom template support
  • Interactive web UI output

javimosch/supercli commit 4c8e40fab4

Frequently asked questions

npx get-skill add javimosch/apidoc