-
Notifications
You must be signed in to change notification settings - Fork 38
Help Pages and Strongly Typed Client API
Help Pages for ASP.NET Web API is based on the info of controllers provided by ApiExplorer. If you want the client API generated has doc comments identical to the doc comments of the Web API controllers, you should make sure the XML documentation file is generated and saved into the App_Data folder of the Web API project, and Help Page could display the doc comments, as described in section "Adding API Documentation" of Help Pages for ASP.NET Web API
So the client programmers may get good hints during programming, in addition to intellisense supported by the client library assembly.
In the .NET Core build of WebApiClientGen, the doc comments in the generated codes are directly imported from the XML file of the .NET Core Web API assembly, since the .NET Core Web API does not come with the help page provider.