Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

API documentation from code (JSDoc and OpenAPI) v1.0.0

Use this resource to document the public functions and endpoints of an API

New

  • 425 downloads
  • 154 likes
  • 182 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install api-documentation-jsdoc-openapi

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent lists the public exports, reads the JSDoc annotations, fills in the missing ones and produces an OpenAPI 3.0 specification for HTTP endpoints. You get complete API documentation aligned with the code.

Mostly picked by

Updated November 2, 2026

Card for the “API documentation from code (JSDoc and OpenAPI)” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: public export scan and JSDoc annotation reading
  • SKILL.md: conventions (@param, @returns, examples) for each export
  • SKILL.md: OpenAPI 3.0 specification generation for endpoints

Good fit for

  • Your TypeScript library has no documentation for its public functions
  • A REST API must be documented for external developers

Not for

    Tags

    • api
    • jsdoc
    • openapi
    • documentation

    About

    You say

    “Document the public exports of the src/api folder and generate the OpenAPI spec for the endpoints.”

    Card for the “API documentation from code (JSDoc and OpenAPI)” skill

    Skill published by ruvnet under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to document the public functions and endpoints of an API
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE1.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md1 KB

    Origin and licence

    Listed unmodified

    Author
    ruvnet
    Source
    github.com/ruvnet/ruflo/tree/89b0cd02dd99ea1f63437fde6c05992ec53cc22b/plugins/ruflo-docs/skills/api-docs
    Licence
    MIT

    Notice

    « api-docs » (ruvnet, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.