Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Débloquer PalateKit

Tout débloquer

Offre

Le paiement vaut acceptation de nos conditions générales de vente.

Paiement sécurisé par Stripe. Reçus et factures envoyés par e-mail.

Content de vous revoir

Connectez-vous pour installer, télécharger ou sauvegarder cette ressource. Un compte gratuit suffit pour les ressources gratuites.

Documentation d'API à partir du code (JSDoc et OpenAPI) v1.0.0

Utilisez cette ressource pour documenter les fonctions publiques et les endpoints d'une API

Nouveau

  • 425 téléchargements
  • 154 mentions J'aime
  • 182 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

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

Sans option, la skill va dans ~/.agents/skills/ ; ajoutez --agent claude-code (ou codex, cursor…) pour viser un agent.

Première fois : connectez la CLI avec

npx --yes palatekit@latest login

L'agent recense les exports publics, lit les annotations JSDoc, complète celles qui manquent et produit une spécification OpenAPI 3.0 pour les endpoints HTTP. Vous obtenez une documentation d'API complète et alignée sur le code.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Documentation d'API à partir du code (JSDoc et OpenAPI) »

Caractéristiques

Guides d'installation
Génère avec
Le modèle de votre agent
Licence
MIT

Ressources similaires

Tout voir

Ce que vous obtenez

  • SKILL.md : analyse des exports publics et lecture des annotations JSDoc
  • SKILL.md : conventions (@param, @returns, exemples) pour chaque export
  • SKILL.md : génération d'une spécification OpenAPI 3.0 pour les endpoints

Pour qui

  • Votre bibliothèque TypeScript n'a pas de documentation de ses fonctions publiques
  • Une API REST doit être documentée pour des développeurs externes

Pas pour qui

    Étiquettes

    • api
    • jsdoc
    • openapi
    • documentation

    À propos

    Vous dites

    « Documente les exports publics du dossier src/api et génère la spécification OpenAPI des endpoints. »

    Carte de la skill « Documentation d'API à partir du code (JSDoc et OpenAPI) »

    Skill publiée par ruvnet sous licence MIT. Fichiers livrés dans leur version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Installez la skill dans le dossier de skills de votre agent
    2. Demandez à votre agent de documenter les fonctions publiques et les endpoints d'une API
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE1,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • SKILL.md1 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    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.

    Avis des utilisateurs

    –

    Aucune note pour l'instant

    Chargement des avis…

    Supprimer votre avis ?

    Votre note et votre commentaire seront retirés de la fiche.