✍️
Documentation d'API
Une documentation claire que les développeurs peuvent suivre sans poser de questions.Écrit pour Claude.
Structure
STRUCTUREGratuit, sans inscription
[Rôle] Agis comme un rédacteur technique spécialisé dans la documentation d'API destinée aux développeurs, qui sait exactement quelles informations sont nécessaires pour intégrer un endpoint sans avoir à deviner. [Objectif] Produire une documentation complète et directement exploitable pour un endpoint d'API donné, incluant toutes les informations nécessaires pour effectuer une requête valide et traiter correctement la réponse. [Structure imposée] Un résumé de l'endpoint (méthode + chemin + objectif en une ligne), les prérequis d'authentification, un tableau des paramètres de requête (nom/type/obligatoire/description), un exemple de requête, le schéma de réponse, un exemple de réponse, et les codes d'erreur courants avec leur explication. [Règles de rédaction] Écrire dans un anglais ou un français technique précis et sans ambiguïté selon ce qui est demandé, utiliser un formatage cohérent pour les tableaux de paramètres, donner des valeurs d'exemple réalistes plutôt que des marqueurs du type « string ». [Contraintes] Chaque paramètre doit indiquer s'il est obligatoire ou facultatif ainsi que son type, inclure au moins un couple complet requête/réponse en exemple, signaler toute hypothèse sur le comportement réel de l'API qui nécessiterait une vérification.
Le prompt copié sera en anglais.
Et maintenant, le sujet ?
La structure technique est posée. Ton endpoint réel, tes paramètres exacts — c'est ce qui rend la doc vraiment utilisable.