Document API Web privé

Question

Nous avons mis en place une API Web pour l'utilisation interne du projet. Je cherche un moyen agréable de documenter notre API. Je l'ai cherché sur le web et a trouvé

• IO Docs
• Swagger

Ces outils lus dans les fichiers JSON qui peuvent être créés automatiquement, par exemple pour Java. Notre API a grandi et j'aime créer le JSON manuellement, mais pas à la main dans un éditeur de texte. Existe-t-il un outil ou une interface qui facilite la création manuelle du JSON descriptif? D'autre part, quels sont les outils recommandés pour la documentation d'une API Web?

Answer 1

Je travaille dans un magasin .NET (C#) et nous utilisons swagger pour documenter nos API. Nous n'avons pas trouvé d'outils pour faire ce que vous demandiez ... alors nous venons de créer le notre. Je ne pense pas que Swagger soit suffisamment mature pour faire apparaître des projets utilitaires comme ça ... pour le moment.

Il n'était pas difficile de créer des classes pour représenter les objets json décrits par la documentation swagger. Nous prenons simplement ces classes instanciées et les exécutons via un sérialiseur JSON pour obtenir nos fichiers json individuels décrivant nos points de terminaison.

Bonne chance!