ASP.NET WebApi 在异常时返回不同的对象

Question

我目前正在开发一个API，需要为该api返回一些对象或者在某处失败的情况下返回错误，主要是因为我依赖于数据库调用。

这是我的一些代码：

    public Student GetStudent(string parametr)
    {
        try
        {
            // Database call 1
            // Database call 2
            return new Student();
        }
        catch (Exception ex)
        {
            // return new ErrorDetails(ex.message); -- example
            return null;
        }
    }

我的一个限制是我需要大摇大摆地使用这个 API。我尝试使用 HttpResponse ，它完全符合我对编码部分的需求，但这不适用于招摇。我的 Web 应用程序不是 asp.net 核心。

对我应该怎么做有什么想法或建议吗？

提前致谢，

Answer 1

您可以使用 Swagger DataAnnotations 并封装返回数据来实现这一点

首先创建一个类来封装这样的错误消息

public class Errors
{
    public List<string> ErrorMessages { get; set; } = new List<string>();
}

然后使用这样的注释

适用于 .NET 4.5+（全框架）

[SwaggerResponse(HttpStatusCode.OK, Type = typeof(Student))]
[SwaggerResponse(HttpStatusCode.BadRequest, Type = typeof(Errors))];
public IHttpActionResult GetStudent(string parametr)
{
    try
    {
        // Database call 1
        // Database call 2
        return Ok(new Student());
    }
    catch (Exception ex)
    {
        Errors errors = new Errors();
        errors.ErrorMessages.Add(ex.Message);

        return Content(HttpStatusCode.BadRequest, errors);
    }
}

对于 .NET Core

[ProducesResponseType(200, Type = typeof(Student))]
[ProducesResponseType(400, Type = typeof(Errors))]
public IActionResult GetStudent(string parametr)
{
    try
    {
        // Database call 1
        // Database call 2
        return Ok(new Student());
    }
    catch (Exception ex)
    {
        Errors errors = new Errors();
        errors.ErrorMessages.Add(ex.Message);
        
        return BadRequest(errors);
    }
}

注意BadRequest只是一个返回的例子，你应该总是返回正确的Http状态码消息，比如404表示未找到，401表示禁止等等