À propos
Voici la documentation de mon API Personnelle disponible sur docs.sylvain.sh. Elle permet de mieux comprendre comment fonctionne mon API et comment l'utiliser.
Fonctionnalités
Cette documentation a été spécialement conçue pour offrir une présentation claire et bien structurée de l'API, afin de faciliter son intégration dans vos projets.
Initialement, la documentation était hébergée sur le domaine api.sylvain.sh, mais j'ai décidé de la déplacer sur un domaine à part pour plusieurs raisons.
Le nouvel emplacement permet de proposer une expérience utilisateur plus fluide avec des explications détaillées, des exemples de code pratiques, et une présentation soignée qui améliore la lisibilité.
L'objectif de cette nouvelle documentation est de vous fournir toutes les informations nécessaires pour utiliser l'API de manière optimale. Vous y trouverez des sections dédiées à chaque service de l'API, avec des descriptions des fonctionnalités, des paramètres d'entrée, et des exemples de requêtes et de réponses.
J'ai également pris soin d'ajouter des explications sur l'architecture REST et sur le fonctionnement de chaque service. Vous pourrez ainsi comprendre en profondeur comment intégrer l'API dans vos applications, que ce soit pour des projets web, des applications mobiles ou d'autres solutions de développement.
Stack technique
Le site de documentation est construit avec VitePress (Vue.js) et offre plusieurs fonctionnalités avancées :
- Support multi-versions : documentation disponible pour chaque version de l'API (v1, v2, v3)
- Bilingue : interface disponible en français et en anglais
- Thème sombre : mode clair et sombre intégré
- Recherche locale : recherche instantanée dans toute la documentation
- Responsive : interface adaptée à tous les appareils
Composants personnalisés
La documentation utilise des composants Vue.js personnalisés pour une meilleure présentation :
- Endpoint : affichage formaté des endpoints API avec méthode et URL
- Method : mise en forme des méthodes HTTP (GET, POST, etc.)
- Request : exemples de requêtes interactifs
- Terminal : simulation de terminal pour les exemples en ligne de commande
- Lang : sélecteur de langue pour basculer entre français et anglais
- Version : sélecteur de version de l'API