SwashBuckle在错误时定义响应主体

我的应用程序是一个 ASP.NET Core 1.0 Web API。

我的应用程序是一个 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 都会向我显示以下消息:

enter image description here

我怎样才能实现一个响应机构,如:

"请输入 5 个数字"

非常感谢。

6

您可以使用[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"));
    ...
});
2

我正在使用 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 cl to handle validation errors from modelState or exception.
    /// </summary>
    public cl 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

本站系公益性非盈利分享网址,本文来自用户投稿,不代表码文网立场,如若转载,请注明出处

(821)
如何在 Java中绘制一个体面的圆圈
上一篇
Ical/Apple日历集成
下一篇

相关推荐

  • vb如何编写程序代码Private Sub Form_Load() ' 设置窗口标题 Me.Caption = He

    示例示例VB程序代码的编写是通过使用Visual Basic编程语言来实现的。下面是一个简单的VB程序代码示例:'示例代码…

    2023-03-14 15:57:06
    0 92 52
  • code键 A Guide to Success

    示例示例code键是一个特殊的键,它可以用来输入代码。它通常位于键盘的右上角,并且有一个特殊的图标,如“#”或“@”。下面是一个简单的代码示例,使用code键来输入代码:…

    2023-02-13 08:43:06
    0 16 58
  • type c接口是啥改变你的充电体验

    示例示例Type C接口是一种新型的USB连接器,它可以支持更高的数据传输速度,比传统的USB 0接口更快。与传统的USB接口不同,Type C接口可以在两端都使用,无需额外的翻转,使连接更加方便快捷。下面是一个使用Type C接口的代码示例:…

    2023-01-12 02:06:09
    0 24 33
  • good catch什么意思:好抓住!让你的梦想变成现实

    示例示例Good catch是一种表扬语,用来表扬某人发现了一个有价值的信息或问题。它可以用来表扬别人的观察力、思考能力和分析能力。例如:…

    2023-02-17 03:14:17
    0 70 47
  • carwings是什么意思智能汽车连接系统的未来

    Carwings是日产汽车公司推出的一款远程智能汽车服务,它可以帮助用户远程监控汽车的状态和行驶信息,并且可以远程控制汽车的功能。…

    2023-01-19 13:55:38
    0 38 30
  • cvt变速箱油分几种:CVT变速箱油的种类及用法

    cvt变速箱油一般分为三种,分别是:传统cvt变速箱油:代码:CVT-1…

    2023-01-27 12:23:25
    0 73 14
  • cv人生履历:从零开始,一步步走向成功——[姓名]的职业生涯

    cv人生履历是一种概括性的文件,用于描述一个人的教育背景、工作经历、技能、专业知识和其他重要信息的文件。它可以帮助雇主评估求职者的资格,并决定是否面试或录用他们。…

    2023-02-01 13:25:09
    0 69 46
  • cs go 国际服挑战国际赛场,体验全新竞技乐趣

    CS GO国际服是一种多人在线游戏,由Valve Corporation开发,可以在Steam平台上进行游戏。它是一款基于Counter-Strike系列游戏的竞技游戏,玩家可以在两个不同的队伍中进行游戏,一个是攻击者(Terrorists),另一个是防守者(Counter-Terrorists)。玩家可以通过购买武器,装备,技能,以及其他道具来提高游戏能力。…

    2023-03-08 00:34:44
    0 96 36

发表评论

登录 后才能评论

评论列表(49条)