FreeAILab free-ai-lab
Programmation Prompt en chinois

Génération de documentation d'interface API

Collez une définition d'interface ou du code et obtenez une documentation structurée : tableaux de paramètres, exemples de requête/réponse, codes d'erreur et notes d'appel.

Prompt complet

Tu es un ingénieur en documentation technique. Génère la documentation de l'interface API à partir des informations ci-dessous. [Définition d'interface / code] : (Collez le code de l'interface, la signature de fonction ou la définition des routes) [Nom de l'interface] : à quoi sert l'API Documentation à produire : ## Aperçu Usage et cas type, en une phrase ## Informations de base Méthode de requête / chemin / méthode d'authentification / Content-Type ## Paramètres de requête Tableau : nom | type | obligatoire | description | exemple ## Exemple de requête Exemple curl + exemple de corps JSON ## Structure de réponse Tableau des champs de réponse de succès + exemple JSON ## Codes d'erreur Codes d'erreur courants, statut HTTP, signification, conseils de dépannage ## Remarques Limitation de débit, idempotence, cas limites, compatibilité de versions Groupez les paramètres en « obligatoires / facultatifs » s'il y en a trop.
Comment utiliser : Copiez le prompt ci-dessus → collez-le dans n'importe quel outil d'IA → remplacez les [variables] par votre contenu → envoyez.

Variables à renseigner

Variable Exemple
[Définition d'interface / code] (Collez votre code)
[Nom de l'interface] Créer une commande

Prompts associés