正确的姿势写ASP .NET WebAPI接口
接口注释加入remarks标签
在方法上一行输入///自动生成注释大家肯定都会但是这里的注释只包括summary、 param 、returns,其实你还应该加入
微软注释介绍文档:https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/xmldoc/
标明ProducesResponseType特性
在接口上加入200、401、500等不同返回状态码特性,方便接口对接人员更具不同的返回状态进行编码
不同状态码枚举:https://docs.microsoft.com/zh-cn/dotnet/api/system.net.httpstatuscode?view=net-6.0
使用 FromQuery、FromHeader、FromBody特性注明参数来源
这样可以避免去httpcontent中获取参数内容更加直观
使用异步返回值async关键字
增加接口吞吐量
最终示例如下
/// <summary>
/// 接口名称
/// </summary>
/// <remarks>
/// 接口描述
/// </remarks>
/// <param name="hierarchyRequest">请求tag名称</param>
/// <param name="token">token</param>
/// <returns>返回值说明</returns>
[HttpGet, Route("demo")]
[ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(返回类型))]
[ProducesResponseType((int)HttpStatusCode.Unauthorized)]
public async Task<IActionResult> MyMethod([FromQuery] Request request,[FromHeader(Name = "access_token")]string token)
{
return Ok(返回值);
}