866d0df45c
feat(docs): update API_documentation.md with comprehensive API specifications for all entities, SDK methods, and integration endpoints feat(docs): update api_specification.md to align with the updated API documentation and guide the development of the new backend
56 lines
3.3 KiB
Markdown
56 lines
3.3 KiB
Markdown
# Guide de Maintenance de la Documentation API
|
|
|
|
Ce document décrit la procédure à suivre pour mettre à jour la documentation de l'API et la spécification technique de notre backend après des modifications majeures sur la plateforme Base44.
|
|
|
|
Suivre ce processus est **essentiel** pour garantir que notre backend personnalisé sur GCP reste synchronisé avec les fonctionnalités du frontend.
|
|
|
|
## Quand Lancer cette Procédure ?
|
|
|
|
Vous devez suivre ce guide après chaque cycle de développement significatif sur la plateforme Base44, notamment après :
|
|
- L'ajout de nouvelles entités ou de nouveaux champs de données.
|
|
- La modification de la logique métier existante.
|
|
- L'intégration de nouvelles fonctionnalités majeures dans l'interface utilisateur.
|
|
|
|
---
|
|
|
|
## Procédure de Mise à Jour
|
|
|
|
### Étape 1 : Obtenir la Documentation à Jour de Base44
|
|
|
|
1. **Ouvrez le fichier `docs/base44_prompts.md`**.
|
|
2. Copiez le contenu du **"Prompt Principal"**.
|
|
3. Collez ce prompt dans le chat de l'IA de Base44 pour lui demander de générer la documentation la plus récente.
|
|
4. **Vérification :** L'IA doit retourner le contenu complet du fichier `API_documentation.md`. Si elle ne retourne qu'un résumé, utilisez le prompt simple suivant pour demander le contenu complet :
|
|
```text
|
|
Thank you for the summary. Please provide the entire, updated content of the API_documentation.md file now.
|
|
```
|
|
|
|
### Étape 2 : Mettre à Jour le Fichier de Documentation Local (avec Gemini CLI)
|
|
|
|
Pour garantir un formatage propre et cohérent, il est recommandé d'utiliser Gemini CLI pour cette étape.
|
|
|
|
1. **Copiez le contenu brut** fourni par l'IA de Base44.
|
|
2. **Donnez ce contenu à Gemini CLI** avec un prompt simple, par exemple :
|
|
> "Voici la nouvelle documentation de l'API Base44. Peux-tu reformater ce contenu et mettre à jour le fichier `docs/API_documentation.md` ?"
|
|
3. **Laissez Gemini CLI** gérer la création ou la mise à jour du fichier. Il s'assurera que les tableaux, les blocs de code et les en-têtes sont correctement formatés.
|
|
|
|
### Étape 3 : Mettre à Jour la Spécification de l'API GCP (avec Gemini CLI)
|
|
|
|
C'est l'étape la plus critique. Au lieu d'une comparaison manuelle fastidieuse, nous allons nous appuyer sur l'IA pour synchroniser notre plan de migration.
|
|
|
|
1. **Assurez-vous que l'Étape 2 est terminée** et que `docs/API_documentation.md` est à jour.
|
|
2. **Demandez à Gemini CLI** de mettre à jour la spécification pour vous. Utilisez un prompt clair, par exemple :
|
|
> "Maintenant que `docs/API_documentation.md` est à jour, peux-tu analyser les changements et mettre à jour de manière exhaustive le fichier `docs/api_specification.md` pour qu'il corresponde ?"
|
|
3. **Laissez Gemini CLI** effectuer l'analyse comparative et appliquer les modifications nécessaires (ajout de champs, d'entités, d'intégrations, etc.) au fichier de spécification.
|
|
|
|
### Étape 4 : Valider et Commiter les Changements
|
|
|
|
1. Relisez une dernière fois les modifications apportées à `api_specification.md` pour vous assurer qu'elles sont cohérentes.
|
|
2. Commitez les fichiers mis à jour dans Git avec un message clair et descriptif.
|
|
```bash
|
|
git add docs/API_documentation.md docs/api_specification.md docs/MAINTENANCE_GUIDE.md
|
|
git commit -m "docs: Update API documentation and specification from Base44 export"
|
|
```
|
|
|
|
---
|