526互联

标准的WebApi应该有哪些元素

发布时间 2023-04-15 14:21:59作者: 喜爱糖葫芦

提问

标准的WebApi应该有哪些元素

回答

  1. 声明完整的响应码200,404,401,400
  2. 添加Operation
  3. 添加Tag聚合业务
  4. 申明请求和响应类型
  5. 标注参数来源FromHeader
  6. 使用IActionResult代替ActionResult
    [Tag("查询类服务")]
    [HttpGet, Route("mytoute", Name = nameof(GetSomething))]
    [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof([数据类型]))]
    [ProducesResponseType((int)HttpStatusCode.NotFound, Type = typeof(string))]
    public IActionResult GetSomething([FromQuery] string va,[FromHeader(Name = "access_token")]string token)
    {
        //TODO
        if (OK)
            return Ok([结果]);
        return NotFound("没找到");
    }