Comment rédiger des exemples d'API à partir de la documentation fournie
Les exemples d'API aident à relier la description d'un point de terminaison à une structure concrète de requête et de réponse. L'exactitude dépend de la méthode, des champs et des exigences d'authentification réellement fournis.
Commencez avec le bon contenu.
- Ce que vous fournissez
- une page de référence d’API où la méthode, le chemin et le schéma sont visibles.
- Le résultat attendu
- Enregistrez des exemples de requêtes avec des identifiants fictifs à remplacer et uniquement les champs documentés.
Comment fonctionne le processus.
Utilisez le schéma documenté et des valeurs d'exemple clairement fictives. Préservez la distinction entre champs obligatoires et facultatifs, et remplacez les identifiants par des valeurs de substitution plutôt que d'inclure de vrais secrets.
Les points à vérifier dans le résultat.
Validez l'exemple dans l'environnement pertinent avant de le publier comme testé. Une requête ou réponse plausible ne prouve pas que le point de terminaison existe ou se comporte comme indiqué.
Lisez le texte comme un résultat modifiable et vérifiez-le avec la source. Préservez les références, noms et conditions importants lorsque vous le copiez dans un autre document ou message.
Apprenez à partir de l’exemple détaillé.
Utilisez l’exemple téléchargeable pour comprendre la forme du résultat. Comparez-le à l’exemple source, puis appliquez les mêmes vérifications factuelles au contenu fourni pour votre propre tâche.
L’exemple fourni est illustratif. Il ne s’agit pas d’une exécution enregistrée sur vos données.
Télécharger l’exemple ↓Utilisez-le avec vos propres contenus.
- Ouvrez la source à utiliser et activez WebAct dans cet onglet.
- Copiez la tâche depuis la section d’introduction, ajoutez les champs ou préférences nécessaires et vérifiez les actions proposées.
- Comparez le premier résultat à votre source. Demandez une correction ou un ajustement précis si nécessaire.