我的应用程序是一个 ASP.NET Core 1.0 Web API。
我有以下控制器:
[HttpGet("{someData:MinLength(5):MaxLength(5)}")]
[Produces("application/json")]
public async Task<IActionResult> GetSomeData(string someData)
{
return this.Ok(JsonConvert.SerializeObject("Data is: " + someData));
}
每当我传递例如字符串“111”时,swagger 都会向我显示以下消息:
我怎样才能实现一个响应机构,如:
"请输入 5 个数字"
非常感谢。
您可以使用[ProducesResponseType(typeof(ModelStateDictionary), (int)HttpStatusCode.OK)]
注释您的操作,以返回典型的 Dictionary 类型的错误消息,如使用return BadRequest(ModelState)
时。
但你不能在模式定义中返回文本。它在那里是 json 结构,而不是错误消息。相反,您应该使用 xmldoc (并且也在 swagger 中启用它) 为参数添加描述。
更新:添加参数及其含义的文档的替代方法
/// <summary>
/// Returns some data based on <paramref name="someData"/> parameter.
/// </summary>
/// <param name="someData">Some data. (Must be exactly 5 characters wide)</param>
/// <response code="200">Returns indexed tags on success</response>
/// <response code="400">Invalid data sent</response>
/// <returns>A paged list of results</returns>
[HttpGet("{someData:MinLength(5):MaxLength(5)}")]
[ProducesResponseType(typeof(MyReturnType), (int)HttpStatusCode.OK)]
[ProducesResponseType(typeof(void), (int)HttpStatusCode.BadRequest)]
public async Task<IActionResult> GetSomeData(string someData)
{
}
您还需要在项目的属性中启用 xmldocs 的构建。
并添加到您的启动:
services.AddSwaggerGen(options =>
{
...
var appEnv = PlatformServices.Default.Application;
options.IncludeXmlComments(Path.Combine(appEnv.ApplicationBasePath, $"{appEnv.ApplicationName}.xml"));
...
});
我正在使用 ApiBadRequestResponse 类,它从 modelState 而不是直接 ModelState 构造字符串列表。从一个很好的文章https://www.devtrends.co.uk/blog/handling-errors-in-asp.net-core-web-api复制的类。
使用示例:
[ProducesResponseType(typeof(ApiBadRequestResponse), (int)HttpStatusCode.BadRequest)]
public async Task<IActionResult> GetSomeData(string someData)
{
return BadRequest(new ApiBadRequestResponse(ModelState));
}
实现(基类描述为in the article):
/// <summary>
/// an ApiBadRequestResponse class to handle validation errors from modelState or exception.
/// </summary>
public class ApiBadRequestResponse : ApiResponse
{
public IEnumerable<string> Errors { get; }
public ApiBadRequestResponse(ModelStateDictionary modelState)
: base(HttpStatusCode.BadRequest) //400)
{
if (modelState.IsValid)
{
throw new ArgumentException("ModelState must be invalid", nameof(modelState));
}
Errors = modelState.SelectMany(x => x.Value.Errors)
.Select(x => x.ErrorMessage).ToArray();
}
public ApiBadRequestResponse(Exception exception, string message=null)
: base(HttpStatusCode.BadRequest, message) //400)
{
Errors = new List<string>() {exception.ToString()};
}
}
另一个类似的解决方案是在文章http://www.khalidabuhakmeh.com/a-better-validation-result-for-asp-net-webapi
本站系公益性非盈利分享网址,本文来自用户投稿,不代表码文网立场,如若转载,请注明出处
评论列表(44条)