Parcourir les catégories
Explorer
Fiverr Pro
Français
$
USD
Je rédigerai la documentation API, la spécification openapi swagger, les guides pour développeurs et la documentation SDK
Documentation technique et automatisation des données pour les équipes de développement logiciel
Je suis ingénieur logiciel. J'écris les documents dont les équipes de développement ont besoin et que personne ne veut rédiger : cahiers des charges, références API, manuels utilisateur, runbooks. Et ...
À propos de ce service
Écrivez-moi en italien si vous le souhaitez.
La plupart de la documentation API est rédigée par quelqu’un qui ne peut pas lire le code. C’est pourquoi elle devient obsolète en trois semaines, et pourquoi vos utilisateurs ouvrent encore des tickets pour demander ce que signifient les codes d’erreur.
Je suis ingénieur logiciel. Envoyez-moi le dépôt, la collection Postman ou le fichier de routes — je le lis moi-même et rédige une documentation qui correspond réellement à ce que le service fait.
CE QUE VOUS OBTENEZ
- Chaque point de terminaison : méthode, chemin, authentification, paramètres, requête et réponse
- De vraies réponses d’erreur, avec leur cause et comment y remédier
- Un exemple fonctionnel par endpoint, en curl et dans la langue de votre choix
- Un fichier OpenAPI 3 valide, pour que la documentation puisse être régénérée après modification du code
- Un site de documentation publié sur Redoc, Swagger UI ou Mintlify (Premium)
REST, GraphQL, webhooks et SDKs. Je n’ai jamais besoin de vos clés de production.
Si votre API présente des problèmes de nommage ou de gestion des erreurs, je le dirai avant de commencer à écrire. Documenter une API confuse ne fait que rendre la confusion officielle.
Type de document:
Documentation
•
Spécifications techniques
Secteur:
Logiciel
Langue:
Anglais
•
Italien
Préférence du type de livraison
Veuillez informer le freelance de toute préférence ou préoccupation concernant l'utilisation d'outils d'IA dans la réalisation et/ou la livraison de votre commande.
Mon portfolio
FAQ
Traduction automatique
De quoi avez-vous besoin pour documenter mon API ?
L'un de ces éléments : un dépôt, une collection Postman, un schéma GraphQL, un fichier OpenAPI existant ou une clé sandbox. Si vous n'avez aucun d'eux, un partage d'écran où vous me montrez les appels suffit pour commencer.
Publiez-vous la documentation ou me donnez simplement des fichiers ?
Les deux sont possibles. La documentation de base et de référence sont livrées en Markdown plus un fichier OpenAPI que vous hébergez vous-même. La documentation complète inclut un site de documentation fonctionnel, construit avec un générateur statique, prêt à déployer sur votre propre domaine.
Maintiendrez-vous la documentation à jour lorsque l'API évoluera ?
Oui, en tant que commande séparée plus petite. Envoyez-moi le changelog ou le diff et je mets à jour les sections concernées. Comme vous gardez les fichiers sources, votre équipe peut aussi les maintenir sans moi.
