Description du projet
TraduitNotre API REST a évolué pour inclure plus de quarante points de terminaison et, à ce stade, aucun d'entre eux n'est documenté. Les développeurs qui s'intègrent à nous sont effectivement en train de rétroconcevoir l'API à partir d'exemples de requêtes, ce qui ralentit tout le monde et génère un flux constant de questions de support évitables. Nous voulons corriger cela correctement en commandant une spécification complète OpenAPI 3.0 ainsi qu'un portail développeur poli que les gens peuvent réellement lire et tester.
Nous recherchons quelqu'un qui combine une forte rédaction technique avec une réelle expérience pratique de l'API, car ce travail concerne autant l'explication claire que les schémas précis. Vous produirez une spécification OpenAPI 3.0 YAML complète couvrant chaque point de terminaison, ses schémas de requête et de réponse et ses codes d'erreur, puis vous transformerez cela en documents interactifs hébergés avec Swagger UI ou Redoc. En plus de la référence, nous avons besoin d'un guide de démarrage qui explique l'authentification, les limites de taux, la pagination et la gestion des erreurs, ainsi que des exemples de code à copier-coller en cURL, PHP et JavaScript pour chaque point de terminaison majeur. Complétez-le avec une collection Postman et un modèle de journal des modifications pour l'historique des versions.
Nous fournirons l'accès à l'API, nos documents de code internes existants et la liste complète des points de terminaison ; nous attendons la documentation terminée dans les vingt et un jours.
Livrables :
— 1. Spécification OpenAPI 3.0 YAML — tous les points de terminaison, schémas de requête/réponse, codes d'erreur
— 2. Documentation API interactive — page hébergée Swagger UI ou Redoc
— 3. Guide de démarrage — authentification, limites de taux, pagination, erreurs
— 4. Exemples de code — cURL, PHP, JavaScript pour chaque point de terminaison majeur
— 5. Journal des modifications — modèle d'historique des versions
— 6. Exportation de collection Postman
Processus :
— Nous fournissons : accès à l'API, documents de code existants, liste des points de terminaison
— Vous livrez : documents complets en 21 jours
— Rédaction technique solide et expérience API requises
Nous recherchons quelqu'un qui combine une forte rédaction technique avec une réelle expérience pratique de l'API, car ce travail concerne autant l'explication claire que les schémas précis. Vous produirez une spécification OpenAPI 3.0 YAML complète couvrant chaque point de terminaison, ses schémas de requête et de réponse et ses codes d'erreur, puis vous transformerez cela en documents interactifs hébergés avec Swagger UI ou Redoc. En plus de la référence, nous avons besoin d'un guide de démarrage qui explique l'authentification, les limites de taux, la pagination et la gestion des erreurs, ainsi que des exemples de code à copier-coller en cURL, PHP et JavaScript pour chaque point de terminaison majeur. Complétez-le avec une collection Postman et un modèle de journal des modifications pour l'historique des versions.
Nous fournirons l'accès à l'API, nos documents de code internes existants et la liste complète des points de terminaison ; nous attendons la documentation terminée dans les vingt et un jours.
Livrables :
— 1. Spécification OpenAPI 3.0 YAML — tous les points de terminaison, schémas de requête/réponse, codes d'erreur
— 2. Documentation API interactive — page hébergée Swagger UI ou Redoc
— 3. Guide de démarrage — authentification, limites de taux, pagination, erreurs
— 4. Exemples de code — cURL, PHP, JavaScript pour chaque point de terminaison majeur
— 5. Journal des modifications — modèle d'historique des versions
— 6. Exportation de collection Postman
Processus :
— Nous fournissons : accès à l'API, documents de code existants, liste des points de terminaison
— Vous livrez : documents complets en 21 jours
— Rédaction technique solide et expérience API requises
Textes et traduction Espèces, Virement bancaire
