Nouvelles Chroniques d'Amethyste

Penser au Sens, pas au Verbe

Générer une page d’aide pour vos Web Api

Poster un commentaire

C’est une fonctionnalité que j’ai découvert par hasard il y a quelques jours: le template de site Web Api installe également un outil de génération de pages d’aide pour nos Api, pas besoin de Swagger ou autre, c’est automatique.

J’ai voulu en savoir plus, d’où cet article qui explique comment ça marche et comment personnaliser les pages.

Une démo, une démo

Bon OK je cède à la pression du peuple.

Créez juste un site Web Api et lancez l’url:

~/help

Vous devriez voir ceci s’afficher:

Si on clique sur un lien:

Vous me direz que j’aurai pu être le gars un peu plus curieux, en effet parmi le menu créé par défaut on trouve ceci:

Devinez où nous mène ce lien!!!!!

Bon je vais me rattraper un peu et soulever le capôt.

Comment ça marche?

Tout d’abord, si vous explorez votre projet, vous allez trouver ceci:

Si, si, je vous assure n’avoir jamais rien remarqué depuis des années!!!

Ce beau monde arrive en même temps qu’un package Nuget:

Personnalisation

Vous avez du remarquer sur la première infographie l’absence de documentation pour les Api. C’est normal, l’outil n’est pas suffisamment intelligent pour lire votre code et comprendre de quoi il s’agit. On doit donc l’aider.

La méthode n’est pas mystérieuse, par exemple:

Puis on reparamètre l’appli:

Dans les propriétés de BUILD du projet, cochez « XML documentation file ».

 

Et pour terminer on configure HelpPageConfig pour utiliser le fichier XML ainsi construit. On ouvre le fichier :

~\Areas\HelpPage\App_Start\HelpPageConfig.cs

C’est dans cette classe que l’on peut configurer la page d’aide.

 

Et on y trouve ceci:

On fait comme il est dit et on décommente la ligne:


config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/webapplication1.xml")));

 

Et hop:

 

Bibliographie

 

Publicités

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s