CSFramework.WebApi用户请求对象模型
CSFramework.WebApi服务端开发框架
WebApi后台框架
WebApi框架
原创软件@csframework.com
目录
ModelRequest <标准用户请求类>
public class ModelRequest : IUserRequest
{
[JsonProperty("apikey")]
public string ApiKey { get; set; }
[JsonProperty("data")]
public string Data { get; set; }
[JsonProperty("encrypt")]
public bool DataIsEncrypted { get; set; }
[JsonProperty("sign")]
public string Sign { get; set; }
}
ModelRequest类提供基础的请求信息,包括开发者密钥、请求的数据、是否加密以及数据签名。
此用户请求类型必须对应具体的服务端接口,比如数据处理控制器(DataController)的Add、Delete、Edit、Query方法。若不能对应具体的方法,服务端无法解析和处理用户的请求。
ModelRequestAction <命令请求类、数据操作类>
public class ModelRequestAction : IUserRequestAction, IUserRequest
{
[JsonProperty("act")]
public int Action { get; set; }
[JsonProperty("apikey")]
public string ApiKey { get; set; }
[JsonProperty("cdata")]
public string ClientData { get; set; }
[JsonProperty("data")]
public string Data { get; set; }
[JsonProperty("encrypt")]
public bool DataIsEncrypted { get; set; }
[JsonProperty("op")]
public string Operation { get; set; }
[JsonProperty("sign")]
public string Sign { get; set; }
}
ModelRequestAction类提供命令处理方式和提交的数据,包括命令编号(Action)、具体操作(Operation)开发者密钥、请求的数据、客户端信息、是否加密以及数据签名。
命令编号(Action):指定命令编号,如:采购订单编号为:80100,销售订单编号为:80200
具体操作(Operation):指定具体操作:如:Add/Edit/Delete/Query,或自定义命名如:Lock/Approval等。
客户端信息(ClientData):参考客户端信息类。
ModelRequestClientData <客户端信息类>
ModelRequestClientData类继承IUserRequestClient接口以及IUserRequestClientLogin接口。
IUserRequestClient接口主要包含客户端信息,如客户端类型、设备编码、IP地址、程序版本等信息。
IuserRequestClientLogin接口包含用户登录信息,如登录的账套编号、用户令牌、用户编号。
ModelResponse <服务端回应消息>
ModelResponse类继承IUserResponse接口,用于返回服务端处理结果信息。主要信息有消息编号、返回的数据以及消息内容。Response.Code=0表示正常回应,Response.Code=-1表示操作错误,其他编码为自定义消息。参考:《自定义消息表》
模型说明:
序 | JSON属性 | 说 明 |
1 | code | 0:正常,-1:操作失败。其它编码为自定义消息(>0 or <-1)。 |
2 | msg | 服务器响应的自定义消息。 |
3 | data | 服务器返回客户端的数据,JSON/XML或其它文本数据,明文或对称加密的数据。 |
4 | encrypt | data是否对称加密(true/false),预设为不加密=false。 若data是DES加密的数据,encrypt必须=true,客户端接受到响应消息,首先判断encrypt属性是否=true,则对data进行des解密。 |
C#代码: