web-dev-qa-db-fra.com

Description de la page d'aide WebApi

Qu'est-ce qui remplit la description de la méthode Webapi sur la page d'assistance et le paragraphe d'introduction?

enter image description here

asp.net-mvcasp.net-web-api
53
heymega

Selon cela article vous pouvez utiliser les commentaires de documentation XML pour créer la documentation. Pour activer cette fonctionnalité, ouvrez le fichier Areas/HelpPage/App_Start/HelpPageConfig.cs et décommentez la ligne suivante:

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

Activez maintenant la documentation XML. Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet et sélectionnez Propriétés. Sélectionnez la page Build.

Sous Sortie, vérifiez le fichier de documentation XML. Dans la zone d'édition, tapez "App_Data/XmlDocument.xml".

Ajoutez des commentaires de documentation aux méthodes du contrôleur. Par exemple:

/// <summary>
/// Gets some very important data from the server.
/// </summary>
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

/// <summary>
/// Looks up some data by ID.
/// </summary>
/// <param name="id">The ID of the data.</param>
public string Get(int id)
{
    return "value";
}
82
nznoor

Pour afficher la description, vous devez suivre ceci:

  1. Chaque action dans votre contrôleur Client doit avoir un documentation XML
  2. Ouvrez les propriétés du projet qui contient vos contrôleurs et activez la documentation XML comme ceci: enter image description here

  3. Dans la méthode Register pour HelpPageConfig class (Areas/HelpPage/App_Start/HelpPageConfig.cs) décommentez la ligne 19 et n'oubliez pas de changer le chemin du fichier comme ceci:

    config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/MvcApplication4.XML"))
);

C'est tout ce que vous devez faire. La dernière chose est d'inclure le fichier créé dans App_Data dans votre projet afin que le fichier soit déployé en production.

40
CodeNotFound

Pour ceux d'entre vous qui utilisent VB.NET, vous semblez devoir le faire un peu différemment.

Vous devez aller dans l'onglet " Compiler " (il n'y a pas d'onglet Build) pour le projet d'API Web, puis vous assurer " Générer un fichier de documentation XML "est cochée.

enter image description here

La sortie est en fait placée dans /bin/{projectName} .xml , donc maintenant vous devez modifier l'appel SetDocumentationProvider pour pointer vers le chemin " ~/bin/{projectname} .xml " (évidemment, remplacez {projectname} par votre nom de projet réel).

Cela semble malodorant, alors s'il vous plaît laissez-moi savoir si quelqu'un trouve une façon différente de le faire.

0
ChrisC