Previous topicNext topic
Help > 开发指南 > API对接 > HttpServer >
返回数据格式ReturnedObject

一个正式的WebAPI需要返回格式统一的结果,方便客户端对接并获得相应的数据。平台内提供了一个类ReturnedObject。

/// <summary>
/// WebAPI返回对象
/// </summary>
public class ReturnedObject
{
    /// <summary>
    /// API返回的代码
    /// </summary>
    public int Code { get; set; }
    /// <summary>
    /// 要返回的文本信息
    /// </summary>
    public string Message { get; set; }
    /// <summary>
    /// API是否正确返回
    /// </summary>
    public bool Successed { get; set; }
    /// <summary>
    /// 返回的数据信息
    /// </summary>
    public object Data { get; set; }

}

此类提供几个比较典型的属性,方便我们传递API的结果与数据。