ASP.NET l'API Web Page d'Aide de la documentation à l'aide de Xml commentaires sur les contrôleurs de

J'ai installé le ASP.NET l'API Web Page d'Aide paquet et que vous souhaitez l'utiliser pour générer la documentation pour mon API actions du contrôleur à l'aide de Xml commentaires déjà sur eux.

Je suis tombé sur un article sur Yao blog MSDN où il discute de la façon dont les documents peuvent être générés sur la base des commentaires XML.

Toutefois, dans le Registre de la méthode de HelpPageConfig, le SetDocumentationProvider méthode attend une instance de XmlDocumentationProvider construit avec un chemin d'accès physique à un fichier de documentation Xml.

Est-il une autre façon de le faire? Je ne suis pas clair pourquoi j'ai besoin de pointer vers un fichier de documentation Xml.

Grâce

InformationsquelleAutor George Durzi | 2013-02-12
  1. 27

    La XmlDocumentationProvider est à la recherche d'un fichier xml(avoir vos commentaires de code xml) qui est généré lors de la compilation de votre projet.
    Vous pouvez activer la génération de ce en allant à votre projet de Propriétés -> Build -> Sortie. Ici, sélectionnez la case à cocher fichier de Documentation XML.

    • Kiran, merci à vous, cela fait l'affaire. Est-il un bon moyen pour accéder par programme cette valeur au moment de l'exécution? Droit maintenant, je suis en train de faire HttpContext.Actuel.Serveur.MapPath ...
    • merci beaucoup pour cette réponse, enfin compris comment faire ce travail.
    • Encore même, je vois toujours "Aucune documentation n'est disponible"
    InformationsquelleAutor Kiran Challa
  2. 37

    Si vous avez encore des problèmes, voir les étapes ci-dessous.

    Étape 1 - Ajouter un commentaire sur le contrôleur de niveau

    //GET api/documentation
///<summary>
///This is how we create a documentation
///</summary>
///<returns></returns>
public IEnumerable<string> Get()

    Étape 2 - Construction De La Propriété
    Page de Propriétés du projet et de configurer la sortie xml pour la documentation

    ASP.NET l'API Web Page d'Aide de la documentation à l'aide de Xml commentaires sur les contrôleurs de

    Étape 3 - HelpPage Config

    Pour configurer le HelpPageConfig à l'utilisation de nos documents xml fichier, passez à l' ~\Areas\HelpPage\HelpPageConfig.cs.

    Par défaut, le fichier de configuration.SetDocumentationProvider déclaration est commenté. L'utilisation de cette instruction, et le point de l'emplacement de DocumentationProvider à notre fichier xml:

    public static void Register(HttpConfiguration config)
{
   //Uncomment the following to use the documentation from XML documentation file.
   config.SetDocumentationProvider(
            new XmlDocumentationProvider(
                HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")));
}

    EDIT:

    L'emplacement de la HelpPageConfig dans une nouvelle API Web du projet 2.2 créé en VS2013 est ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

    • L'emplacement de la HelpPageConfig dans une nouvelle API Web du projet 2.2 créé en VS2013 est ~\Zones\HelpPage\App_Start\HelpPageConfig.cs
    • Merci pour la clarification
    InformationsquelleAutor Rikin Patel
  3. 2

    Je sais que cette question est résolue, mais dans le cas où il aide quelqu'un
    J'ai trouvé cette page en raison de la recherche de solution pour la documentation pour IHttpActionResult

    Comment ajouter IHttpActionResult dans la documentation

    InformationsquelleAutor cpoDesign