{"id":39,"date":"2017-03-05T13:56:00","date_gmt":"2017-03-05T19:56:00","guid":{"rendered":"https:\/\/www.chrystalsander.com\/blog\/?p=39"},"modified":"2023-07-26T12:56:01","modified_gmt":"2023-07-26T17:56:01","slug":"net-adding-custom-asp-net-webapi-help-page","status":"publish","type":"post","link":"https:\/\/www.chrystalsander.com\/blog\/?p=39","title":{"rendered":".NET : Adding custom ASP.NET WebApi Help Page"},"content":{"rendered":"

\n1.  Add annotations to model, controller, etc. using System.ComponentModel.DataAnnotations
\n2.  Navigate to project “Properties” –> “Build” –> Output
\n3.  Check “XML Documentation file:”, then type in a name for the help document xml, and save
\n4.  In the solution, navigate to “Areas” –> “App_Start” –> “HelpPageConfig.cs”
\n5.  Uncomment the “config.SetDocumentationProvider…” line, add your created name for the help document xml, and save:
\n <\/span>config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath(“~\/App_Data\/DevOpsTaskHelp.XML”)));
\n6.  Build solution, navigate to help page “API”, and your annotations should be present.<\/p>\n

\nAdding XML WebApi Comments To Swagger:
\n1.  Install-Package “Swashbuckle”
\n2.  Open the “SwaggerConfig.cs” file and uncomment the following line:
\n <\/span>c.IncludeXmlComments(GetXmlCommentsPath());
\n3.  Generate method for “GetXmlCommentsPath()”
\n <\/span> private static string GetXmlCommentsPath()
\n        {
\n            return System.String.Format(@”{0}binDevOpsTaskHelp.XML”, System.AppDomain.CurrentDomain.BaseDirectory);
\n        }<\/p>\n

\nREFERENCE(S):
\nhttps:\/\/docs.microsoft.com\/en-us\/aspnet\/web-api\/overview\/getting-started-with-aspnet-web-api\/creating-api-help-pages<\/a>
\nhttps:\/\/blogs.msdn.microsoft.com\/yaohuang1\/2012\/09\/30\/asp-net-web-api-help-page-part-1-basic-help-page-customizations\/<\/a><\/p>\n

\n<\/div>\n","protected":false},"excerpt":{"rendered":"

1.  Add annotations to model, controller, etc. using System.ComponentModel.DataAnnotations 2.  Navigate to project “Properties” –> “Build” –> Output 3.  Check “XML Documentation file:”, then type in a name for the help document xml, and save 4.  In the solution, navigate to “Areas” –> “App_Start” –> “HelpPageConfig.cs” 5.  Uncomment the “config.SetDocumentationProvider…” line, add your created name … Continue reading “.NET : Adding custom ASP.NET WebApi Help Page”<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[20,23,17],"tags":[65,77,68],"_links":{"self":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/39"}],"collection":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=39"}],"version-history":[{"count":1,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/39\/revisions"}],"predecessor-version":[{"id":213,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/39\/revisions\/213"}],"wp:attachment":[{"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=39"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=39"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.chrystalsander.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=39"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}