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.

Rédiger la référence d'une API v1.0.0

Utilisez cette ressource pour rédiger la documentation de référence d'une API, endpoint par endpoint

Nouveau

  • 595 téléchargements
  • 182 mentions J'aime
  • 206 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install api-reference-documentation-2

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 vous guide pour décrire chaque endpoint de votre API, ses paramètres, ses réponses et ses erreurs, avec des exemples d'appel. Vous obtenez une référence de départ à relire et à publier.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Rédiger la référence d'une API »

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 : étapes de rédaction et exemples
  • SKILL.md : prérequis, sorties attendues et erreurs courantes

Pour qui

  • Vos développeurs externes n'ont pas de documentation à jour
  • Vous publiez une nouvelle version de votre API

Pas pour qui

    Étiquettes

    • documentation
    • api
    • référence
    • endpoints
    • exemples

    À propos

    Vous dites

    « Rédige la référence de notre endpoint de création de commande, avec exemples de requête et de réponse. »

    Carte de la skill « Rédiger la référence d'une API »

    Skill publiée par Jeremy Longshore <jeremy@intentsolutions.io> 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 rédiger la documentation de référence d'une API, endpoint par endpoint
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE1,1 Ko
    • NOTICE-PALATEKIT.md0,6 Ko
    • SKILL.md2,3 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    Jeremy Longshore <jeremy@intentsolutions.io>
    Source
    github.com/jeremylongshore/tons-of-skills-marketplace/tree/ab85a061f7bcc039dac13ee193de7a4cd4388571/skills/17-technical-docs/api-reference-creator
    Licence
    MIT

    Notice

    « api-reference-creator » (Jeremy Longshore <jeremy@intentsolutions.io>, 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.