asp.net-web-api-helppages

ApiExplorer does not recognize route attributes with custom type

…衆ロ難τιáo~ 提交于 2019-12-02 03:42:31
I have a project where I want to use route attributes with a custom type. The following code where I have the custom type as a query parameter works fine and the help page displays the custom type. // GET api/values?5,6 [Route("api/values")] public string Get(IntegerListParameter ids) { return "value"; } WebApi.HelpPage gives the following documentation Help:Page If I change the code to use route attributes, the result is that I get an empty help page. // GET api/values/5,6 [Route("api/values/{ids}")] public string Get(IntegerListParameter ids) { return "value"; } When I inspect the code I

VS 2017 WebAPI Help Page - No Document Provided

好久不见. 提交于 2019-12-01 06:49:44
I have followed the steps at MSDN , and other SO questions, to setup documenting and to have the XML comments show in the descriptions section of the help page. However, I am receiving errors when I try to build or run the project. Visual Studio 2017 no longer has the "Build" selection in properties. It has been replaced by the "Compile" section. While this section does have the "Generate XML documentation file" option, it does not have a XML documentation file location option (as in the MSDN directions). That being said, we know that the XmlDocumentProvider is looking for "~/App_Data

VS 2017 WebAPI Help Page - No Document Provided

余生颓废 提交于 2019-12-01 04:31:34
问题 I have followed the steps at MSDN, and other SO questions, to setup documenting and to have the XML comments show in the descriptions section of the help page. However, I am receiving errors when I try to build or run the project. Visual Studio 2017 no longer has the "Build" selection in properties. It has been replaced by the "Compile" section. While this section does have the "Generate XML documentation file" option, it does not have a XML documentation file location option (as in the MSDN

ASP.NET Help Pages default home page?

假装没事ソ 提交于 2019-11-30 10:59:24
问题 I want to go to http://myserver and be able to get Help Pages as the default home page, so the first thing a guest to http://myserver should see is the Help Page. I have a default route set up like this: public static void RegisterRoutes(RouteCollection routes) { routes.IgnoreRoute("{resource}.axd/{*pathInfo}"); routes.MapRoute( name: "Default", url: "{controller}/{action}/{id}", defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional } ); } Then I have my Help Page

ASP.NET Help Pages default home page?

僤鯓⒐⒋嵵緔 提交于 2019-11-29 22:59:33
I want to go to http://myserver and be able to get Help Pages as the default home page, so the first thing a guest to http://myserver should see is the Help Page. I have a default route set up like this: public static void RegisterRoutes(RouteCollection routes) { routes.IgnoreRoute("{resource}.axd/{*pathInfo}"); routes.MapRoute( name: "Default", url: "{controller}/{action}/{id}", defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional } ); } Then I have my Help Page Area registration set up like this: public override void RegisterArea(AreaRegistrationContext context)

ASP Web API Help pages - Link to class from XML <see> tag

 ̄綄美尐妖づ 提交于 2019-11-29 17:27:27
I'm working on Developing a Web-API project, and i'm very impressed with the auto generated documentation by Microsoft's HelpPages. i enabled custom documentation using the official site creating Help Pages the documentation is generated successfully BUT none of the references to Classes from the <See cref=""> Tag seems to be added to the description, the HelpPages Simply ignores them (that's for a reason). i really wanted to have this feature in my project, i searched a lot (got close sometimes) but none gave a convincing answer. That's why i decided to post my solution to this tweak and

Web API Help pages - customizing Property documentation

故事扮演 提交于 2019-11-29 09:48:24
问题 I have my web api and I added the web api help pages to auto-generate my documentation. It's working great for methods where my parameters are listed out, but I have a method like this: public SessionResult PostLogin(CreateSessionCommand request) And, on my help page, it is only listing the command parameter in the properties section. However, in the sample request section, it lists out all of the properties of my CreateSessionCommand class. Parameters Name | Description | Additional

WebAPI Help Pages: disable for Production release

烂漫一生 提交于 2019-11-29 01:30:23
I have developed a number of internal REST interfaces using the older WCF framework in VS 2010. The ability for it to generate help pages was handy for DEV and QA platforms, but for a production release it was easy to disable the generation of these help pages in the web.config file: <standardEndpoint name="" helpEnabled="false" automaticFormatSelectionEnabled="true"/> I am now moving on to use the WebAPI framework instead (currently version 1 on VS 2012), but it doesn't appear to be as trivial to turn this feature off (i.e. I can't find any information on how to do this in a web.config file).

Web Api Help Page XML comments from more than 1 files

こ雲淡風輕ζ 提交于 2019-11-28 17:34:39
I have different plugins in my Web api project with their own XML docs, and have one centralized Help page, but the problem is that Web Api's default Help Page only supports single documentation file new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")) How is it possible to load config from different files? I wan to do sth like this: new XmlDocumentationProvider("PluginsFolder/*.xml") You can modify the installed XmlDocumentationProvider at Areas\HelpPage to do something like following: Merge multiple Xml document files into a single one: Example

ASP Web API Help pages - Link to class from XML <see> tag

我的未来我决定 提交于 2019-11-28 11:11:43
问题 I'm working on Developing a Web-API project, and i'm very impressed with the auto generated documentation by Microsoft's HelpPages. i enabled custom documentation using the official site creating Help Pages the documentation is generated successfully BUT none of the references to Classes from the <See cref=""> Tag seems to be added to the description, the HelpPages Simply ignores them (that's for a reason). i really wanted to have this feature in my project, i searched a lot (got close