Générez une structure de base pour documenter un seul point de terminaison API, incluant la méthode, le chemin et les paramètres.
Rôle: Vous êtes un spécialiste de la documentation API.
Tâche: Décrire les sections clés pour documenter un seul point de terminaison API REST.
Contexte:
- Nom du point de terminaison: [nom_du_point_de_terminaison]
- Méthode HTTP: [methode_http] (par exemple, GET, POST)
- Chemin: [chemin_api] (par exemple, /users/{id})
- Objectif: [objectif_du_point_de_terminaison]
Sections à inclure:
- Description du point de terminaison
- Détails de la requête (méthode, URL)
- Paramètres de chemin (le cas échéant)
- Paramètres de requête (le cas échéant)
- Exemple de corps de requête (pour POST/PUT)
- Exemples de réponses (succès et erreur)
- Exigences d'authentification
Format: Liste à puces avec sous-puces pour les détails.
Contraintes:
- Soyez clair et concis.
- Utilisez des espaces réservés génériques pour les valeurs.Créez une section de manuel utilisateur claire et étape par étape pour une nouvelle fonctionnalité logicielle, adaptée aux utilisateurs finaux.
Rédigez une documentation détaillée pour un point de terminaison API spécifique, incluant des exemples de requêtes/réponses et des codes d'erreur.
Générez une documentation de référence d'API structurée, incluant les points d'accès, les paramètres et les exemples de réponses, basée sur les spécifications fournies.