C# WebAPI ApiExplorer帮助页参数附加信息
我正在使用MVC4WebAPI,有一些问题C# WebAPI ApiExplorer帮助页参数附加信息,c#,asp.net-mvc,asp.net-web-api,asp.net-mvc-apiexplorer,asp.net-web-api-helppages,C#,Asp.net Mvc,Asp.net Web Api,Asp.net Mvc Apiexplorer,Asp.net Web Api Helppages,我正在使用MVC4WebAPI,有一些问题 我们如何定义参数页面的“内容”[附加信息”? 默认情况下,此参数表示“在请求正文中定义此参数” 我们如何在参数页面[样本[/strong>]上定义样本数据? 例如,让我们假设一个字符串值应该是“COME”或“GO”,如何在帮助页面上声明该值,而不是获取其默认的“string”值 哪里是放置一些约束的正确位置,例如API将产生的标题值或可能的响应/错误,以便显示在帮助页面上 1) 通过在XML标记中指定参数,可以为参数指定注释。例如: /// <s
默认情况下,此参数表示“在请求正文中定义此参数”
例如,让我们假设一个字符串值应该是“COME”或“GO”,如何在帮助页面上声明该值,而不是获取其默认的“string”值
/// <summary>
/// Put your comments about / description of this API call.
/// </summary>
/// <param name="myParameter">
/// Put your comments about / description of this parameter here.
/// </param>
[Route("")]
public HttpResponseMessage Get(int my Parameter)
{
// Code for your action
}
//
///请发表有关此API调用的评论/说明。
///
///
///请将您对此参数的评论/说明放在此处。
///
[路线(“”)
公共HttpResponseMessage Get(int my参数)
{
//你的行为准则
}
如果您的参数是复杂类型,并且需要有关该复杂类型属性的文档,则发布的版本当前不支持此操作。但是,它在夜间构建版本中工作,如下所示:
2) 您可以按照此处的说明指定自己的示例数据:
3) 我认为这取决于这是全局的、每个控制器的还是每个动作的。如果它是全局的,您可以将它放在HelpPage区域中Index.cshtml页面的标题下方,并声明它适用于所有api调用。如果是每个控制器或每个操作,我会将其放在该控制器或操作的XML摘要中。我一直在到处寻找(3)的答案,您的建议是我在web上能找到的唯一建议。这不是一个理想的解决方案,但在这一点上,我要它!