Description du projet
TraduitNous avons besoin d'un exécutant qui combine une forte rédaction technique avec une réelle expérience de l'API, car la tâche concerne autant l'explication claire que les schémas précis. Nous devons préparer une spécification YAML OpenAPI 3.0 complète pour tous les points de terminaison — avec des schémas de requête et de réponse et des codes d'erreur — puis la transformer en documentation interactive dans Swagger UI ou Redoc. En plus de la référence, nous avons besoin d'un guide de démarrage couvrant l'authentification, les limites de taux, la pagination et la gestion des erreurs, ainsi que des exemples de code prêts à l'emploi en cURL, PHP et JavaScript pour chaque point de terminaison clé. Une collection Postman et un modèle de journal des modifications complètent le tableau.
Nous fournissons l'accès à l'API, la documentation interne du code et une liste complète des points de terminaison ; nous attendons une documentation terminée dans les 21 jours.
Résultat :
— 1. Spécification YAML OpenAPI 3.0 — tous les points de terminaison, schémas de requête/réponse, codes d'erreur
— 2. Documentation interactive (Swagger UI ou Redoc)
— 3. Guide de démarrage — authentification, limites, pagination, erreurs
— 4. Exemples de code — cURL, PHP, JS pour chaque point de terminaison clé
— 5. Modèle de journal des modifications
— 6. Collection Postman
Processus :
— Nous fournissons : accès à l'API, documentation du code, liste des points de terminaison
— Vous : documentation complète dans les 21 jours