CSFramework.WebApi框架 - DoController - 通用接口控制器说明

CSFramework.WebApi服务端开发框架   WebApi后台框架  WebApi框架 原创软件@csframework.com

DoController通用接口

  通用接口控制器提供两个核心API，能满足任何用户请求或数据处理。

API接口

DoPostObject接口

路由格式：http://localhost:8899/api/do/post

  接口定义：

[HttpPost]
[ActionName("post")]
public IUserResponse DoPostObject(ModelRequestAction request)

  提交指定接口编号以及具体操作的数据格式，参数模型：ModelRequestAction。

  客户端示范代码(C#)：

//构建用户登录信息
ModelRequestClientData client = new ModelRequestClientData();
client.UserID = “admin”;
client.Token = “7e4c23c0aab0”;

//构建<删除采购订单>的请求命令
ModelRequestAction mr = new ModelRequestAction();
mr.Action = “80100”; //命令编号
mr.Operation = “Delete”;
mr.ApiKey =”5b7184d1-2482-4b7e-85f4-93d86bf1f46e”;
mr.Data =”{Key:PO999222}”; //JSON数据
mr.Sign = CryptoHelper.ToMD5(mr.ApiKey + mr.Data +”z3d85f4865b7184d1bf1”);//Sign数字签名
mr.DataIsEncrypted = false;
mr.ClientData = JsonConvert.SerializeObject(client);

//调用WebApi通用接口
string url=”http://localhost:9988/api/do/post”;
string response=HttpTools.Post(url, JsonConvert.SerializeObject(mr));//HTTP-POST

DoPostActionName接口

  路由格式：http://localhost:8899/api/do/postop/80100/Delete

  接口定义：

[HttpPost]
[ActionName("postop")]
public IUserResponse DoPostObject(int id, string op, ModelRequest request)

  提交标准请求数据格式，参数模型：ModelRequest。

  客户端示范代码(C#)：

//构建<查询采购订单>的请求命令
ModelRequest mr = new ModelRequest();
mr.ApiKey =”5b7184d1-2482-4b7e-85f4-93d86bf1f46e”;
mr.Data =”{Key:PO999222}”; //JSON数据
mr.Sign = CryptoHelper.ToMD5(mr.ApiKey + mr.Data +”z3d85f4865b7184d1bf1”);//Sign数字签名
mr.DataIsEncrypted = false;

//调用Do控制器的postop接口
string url=”http://localhost:9988/api/do/postop/80100/Delete”;
string response=HttpTools.Post(url, JsonConvert.SerializeObject(mr)); //HTTP-POST