Service Web en ligne API/guide de référence - Quelle application utilisez-vous pour documenter votre service Web/spécification technique/guide de référence de l'API?Documentation de l'API webservice Guide de référence?
Répondre
Une bonne solution consiste à créer vous-même la documentation en utilisant les commentaires de documentation XML, puis en créant des pages Web à partir du fichier XML résultant.
Bricolage
MSDN article sur l'utilisation de commentaires xml.
Outils/Plugins
Il y a quelques bibliothèques là-bas qui le rendent simple pour vous de créer des documents pour votre api.
Atomineer est très bon et peut créer de la documentation dans de nombreux formats différents pour répondre à vos besoins.
Web API
Avec Web API documentation est roulé dans votre projet avec une interface utilisateur agréable d'exposer. Cela utilise également la documentation XML et vous pouvez ajouter vos propres détails à ce qui sort de la boîte.
[lien brisé, essaie de la retrouver.] Heres un bon blog sur cette méthode api documentaion
IMHO Sandcastle works pretty nicely
Outil gratuit qui utilise la documentation xml existante pour produire des fichiers .chm ou .html qui ressemblent à la documentation msdn.
J'utilise un générateur de documentation appelé TechWriter for Web Services. Ce n'est pas si cher et cela m'a fait gagner beaucoup de temps.