Menu
I've enhanced an older SOAP style web service with REST endpoints. Most everything is working correctly, but I haven't been able to figure out how to change the Introduction on for the auto generated help files. What I have right now is showing the introduction as "Provide a general description of your APIs here."
I've followed this Similar question, but doesn't explain where to change Introduction and have everything else documented, but still don't know where to change the introduction.
I should be using version 2 of Web-API.
215
In Solution Explorer, right-click the project and select Properties. Select the Build page. Under Output, check XML documentation file. In the edit box, type “App_Data/XmlDocument.
NuGet packages (36) A simple Test Client built on top of ASP.NET Web API Help Page.
Web API is a programming interface/application type that provides communication or interaction between software applications. Web API is often used to provide an interface for websites and client applications to have data access. Web APIs can be used to access data from a database and save data back to the database.
Creating API Help PagesInstall ASP.NET and Web Tools 2012.2 Update. This update integrates help pages into the Web API project template. Next, create a new ASP.NET MVC 4 project and select the Web API project template. The project template creates an example API controller named ValuesController .
In Visual Studio's Solution Explorer window go to: YourProject -> Areas folder -> HelpPage -> Views -> Help -> index.cshtml and you will see the text you want to modify.
Alternatively you could just do a find all (Ctrl+Shift+F) for the text you are looking for Provide a general description of your APIs here.
Once you've modified it, save the index.cshtml and refresh the page in your browser. Should be good to go.
51
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
