自定义Web API帮助页面以删除请求格式

Question

In my web api application I am accepting Application/Json mediatype as request. So I would want to customize the help page to remove the other formats such as application/xml, text/xml, application/x-www-form-urlencoded etc. Any help is really appreciable.

Answer 1

As per JSON and XML Serialization in ASP.NET Web API the way to this is to call this from your Application_Start method, defined in Global.asax.

void ConfigureApi(HttpConfiguration config)
{
    // Remove the JSON formatter
    config.Formatters.Remove(config.Formatters.JsonFormatter);

    // or

    // Remove the XML formatter
    config.Formatters.Remove(config.Formatters.XmlFormatter);
}

Answer 2

Go into you help page area and find HelpPageApiModel.cshtml in DisplayTemplates

and remove this lines given below or you can comment it may you need it sometime.

@if (Model.SampleRequests.Count > 0)
{
    <h3>Request Formats</h3>
    @Html.DisplayFor(m => m.SampleRequests, "Samples")
}