Prompts tech et développement
Générez une documentation d’API de niveau Stripe - authentification, endpoints, erreurs, webhooks - afin que les développeurs puissent s’authentifier, effectuer leur premier appel et gérer une erreur en moins de 10 minutes.
Ce prompt de générateur de documentation d’API AI crée une documentation alignée sur les spécifications OpenAPI - présentation, guide d’authentification, démarrage rapide, référence des endpoints avec des exemples de code multilingues, gestion des erreurs avec solutions, limitation du débit, webhooks, SDK, politique de gestion des versions et journal des modifications - dans le format utilisé par les responsables de l’expérience développeur. Collez-le dans Claude, ChatGPT ou n’importe quel chat AI, ajoutez votre spécification d’API et obtenez une documentation prête pour Docusaurus, ReadMe, Mintlify ou GitBook.
L’authentification passe en premier - un développeur qui ne peut pas s’authentifier abandonne. Chaque réponse d’erreur est documentée avec son code d’état, sa cause et la procédure de résolution (les erreurs silencieuses sont interdites). Chaque endpoint inclut des exemples complets et réalistes de requêtes et de réponses dans plusieurs langages - les valeurs d’espace réservé comme "example_value_1" ne sont pas acceptables. Fonctionne avec Claude, ChatGPT ou tout modèle de chat AI.
Ce que vous obtenez
- Un prompt de générateur de documentation d’API AI prêt pour la production (900 mots et plus)
- Structure documentaire complète - présentation, authentification, démarrage rapide, référence des endpoints, erreurs, limites de débit, webhooks, SDK, journal des modifications
- Référence des endpoints avec des exemples de code multilingues (cURL, Python, JavaScript, Go, Ruby - choisissez-en 3 à 5)
- Tableau complet des codes d’erreur - statut, code, cause et résolution pour chaque erreur
- Personnalisation pour les API REST, GraphQL, à nombreux webhooks, d’entreprise/SOAP, internes uniquement et destinées aux partenaires
Conçu pour
Développeurs backend
Équipes plateforme
Relations avec les développeurs
Architectes techniques
Ingénieurs DX