CSFramework.WebApi用户请求对象模型


CSFramework.WebAPI 后端框架-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

dataDES加密的数据,encrypt必须=true,客户端接受到响应消息,首先判断encrypt属性是否=true,则对data进行des解密。

 

C#代码:

C/S框架网|原创精神.创造价值.打造精品

 

版权声明:本文为开发框架文库发布内容,转载请附上原文出处连接
C/S框架网
上一篇:CSFramework.WebApi客户端请求流程图
下一篇:CSFramework.WebApi服务端处理流程与机制
评论列表

发表评论

评论内容
昵称:
关联文章

CSFramework.WebApi用户请求对象模型
CSFramework.WebApi后端框架 - 用户请求类型 (User Request)参数模型
客户端使用HTTPGET请求调用WebApi指定FromUri参数对象模型的接口
CSFramework.WebApi客户端请求流程图
监听WebAPI服务器所有用户请求
ORM模型介绍(ORM Model)- CSFramework.WebApi服务端框架
CSFramework对象模型框架(DbDataUpdate),支持MsSQL,MySQL,Oracle三种数据库操作
CSFramework.WebApi开发框架模拟Web用户端登录、调用WebApi接口增删改查数据
基于Web前端用户调用CSFramework.WebApi服务端登录登出接口实现
Demo调用WebApi接口 - CSFramework.WebApi后端开发框架
CSFramework代码生成器根据数据库表结构生成实体对象模型(C#代码)
CSFramework.DbDataUpdate数据模型框架 - 特殊数据类型测试报告
数字签名(Data Sign)+存取令牌(Access Token)双重安全请求WebApi接口
DbDataUpdate - 自动提交对象模型数据 - 常用数据类型测试
CSFramework.WebAPI 后端框架系统架构图
GateController – 系统安全门禁控制器 - CSFramework.WebApi后端框架
CSFramework代码生成器生成三种ORM模型类(静态类ORM,实体类ORM,标准对象
CSFramework.WebApi服务端处理流程与机制
WebApi接口请求两种常用方式:ModelRequestAction/ModelRequestToken
DbFramework数据库实体类对象模型框架( 支持MsSQL,MySQL,Oracle三种数据库)