c# - WebAPI 返回类型

Question

我是否应该始终返回相同的 JSON 解析对象

示例:

在网站上，用户输入他的用户名和密码。

当用户按下提交时，他会向/api/logintest/{key} 发送请求。如果用户和密码匹配，此 URL 调用的方法是否应该返回一个 JSON 对象，例如 {errMsg: null}，如果不匹配则返回 {errMsg: "bad username or password"}；或者，如果用户详细信息不匹配，我应该返回错误消息，如果找到用户，我应该返回 JSON 中的用户对象吗？

这是我的代码

    [ResponseType(typeof(User))]
    [HttpPost]
    [Route("api/logintest/{key}")]
    public IHttpActionResult LoginTest(LoginForm luser , String key)
    {
        //test the api key
        if(key == "jordanisthebest")
        {
            //we try to get the user by his username and password
            User userReturn = UsersManager.getUserByEmailAndPassword(new User { Email = luser.Email, Password = luser.Password });

            //if the user is null then we return the err message
            if (userReturn == null)
                ModelState.AddModelError("Email", "Bad email or password");

            //if model state is not good we send err msg
            if (!ModelState.IsValid)
                return  Ok(ModelState.getListErrorAndKey(null, typeof(LoginForm)));

            //if all good we return the user
            return Ok(userReturn);
        }

        return NotFound();
    }

Answer 1

如果你想知道他们是否进行了身份验证，那么你可以返回:

{ "authenticated" : true } // or false

如果想知道原因，可以记录或显示:

{ "authenticated": false, "reason" : "User account was locked" }

为了更加 RESTful，您可以制定路线:

GET /api/users/{userName}/authenticate

您的“快乐之路”将返回 HTTP 状态 200 和 JSON 消息作为响应内容。

如果未找到用户(因为 API 调用正在寻找用户资源)，您可以返回 404 未找到的 HTTP 状态代码，但不需要返回 401 的 HTTP 状态代码，因为资源本身不是调用者无权使用的东西。

最好不要向用户公开他们为什么特别未能通过身份验证。您返回给用户的信息越多，黑客的信息就越多，他们甚至可能不知道自己是否拥有有效的用户帐户。