在WEB API中添加状态名称以及返回数据后的消息,通常涉及到API的设计和实现。以下是一个基本的指南,包括基础概念、优势、类型、应用场景以及示例代码。
public class ApiResponse<T>
{
public int StatusCode { get; set; }
public string StatusName { get; set; }
public string Message { get; set; }
public T Data { get; set; }
public ApiResponse(int statusCode, string statusName, string message, T data)
{
StatusCode = statusCode;
StatusName = statusName;
Message = message;
Data = data;
}
public static ApiResponse<T> Success(T data, string message = "操作成功")
{
return new ApiResponse<T>(200, "OK", message, data);
}
public static ApiResponse<T> Error(int statusCode, string statusName, string message)
{
return new ApiResponse<T>(statusCode, statusName, message, default(T));
}
}
[ApiController]
[Route("api/[controller]")]
public class SampleController : ControllerBase
{
[HttpGet]
public IActionResult GetSampleData()
{
try
{
// 模拟获取数据
var data = new { Name = "Sample Data", Value = 123 };
return Ok(ApiResponse<string>.Success(data.ToString(), "数据获取成功"));
}
catch (Exception ex)
{
return StatusCode(500, ApiResponse<string>.Error(500, "Internal Server Error", ex.Message));
}
}
}
通过上述方法,可以在WEB API中有效地添加状态名称和返回数据后的消息,提升API的可维护性和用户体验。
领取专属 10元无门槛券
手把手带您无忧上云