API序【使用此API前请仔细阅读】


版权声明

未经成都携手同鑫网络有限公司明确的书面许可,本文的任何部分不得以任何方式或手段进行复制或传播,或用于任何用途。

对于本文涉及的任何主题,本公司已用于专利、专利应用程序、商标、版权或其他知识产权。提供本文,并不意味着向您授予这些专利、商标、版权或其他知识产权的任何许可。

©2017-2018 成都携手同鑫网络有限公司版权所有。

调用须知

# 应用环境 请求地址 备注
1 测试环境 http://192.168.2.5:4422 本地开发测试环境
2 正式环境 http://zc-api.55128.cn 线上正式环境

验证格式(Header添加参数)

       {
          "Authorization":"token",
          "Expect":"用户Id,用户名",

          注释:Authorization:查询api/JWT/CreateToken返回一个 格式如下eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhZG1pbiIsImF1ZCI6ImJlcnJ5In0.vof8oSjHmN9i2cCt9x66k1ZzKUvplT2QmxIcX4T3Lho)".
                Expect:Berry.Guest,Berry.Guest 作为默认用户,否则验证失败;例子:"12323223,342432324""
        }
    

返回结果示例(不带分页)

       {
            "Status": 2000,
            "Data": [
                {
                    "Id": "8adcef5987fa456eb6bc3cd5de84207f",
                    "Title": "测试广告"
                }
            ],
            "Message": "请求(或处理)成功",
            "BackUrl": null,
            "ExecutionTime": null
        }
    

返回结果示例(带分页)

       {
            "Status": 2000,
            "Data": {
                "TotalPage": 162,
                "PageIndex": 1,
                "TotalRow": 1613,
                "Rows": [
                    {
                        "PK": 7823,
                        "TypeName": "大乐透技巧"
                    }
                ]
            },
            "Message": "请求(或处理)成功",
            "BackUrl": null,
            "ExecutionTime": null
        }
    
# 字段名 类型 描述 备注
1 Status int 状态码 详情参见【错误码说明
2 Data 具体对象 数据集
3 TotalPage int 总页数 仅返回带分页数据时有值
4 PageIndex int 当前页 仅返回带分页数据时有值
5 TotalRow int 总行数 仅返回带分页数据时有值
6 Rows 具体对象 数据集 仅返回带分页数据时有值
7 Message string 服务器消息
8 BackUrl string 跳转地址 如果有需要跳转的地址会返回数据
9 ExecutionTime string 执行时间 单位:毫秒(ms)

开发注释规范

        /// <summary>
        /// API测试控制器
        /// </summary>
        public class TestController : BaseApiController
        {
            /// <summary>
            /// 测试是否连接成功
            /// </summary>
            /// <param name="arg">测试参数</param>
            /// <returns>请求成功则返回成功状态信息</returns>
            [HttpPost]
            public HttpResponseMessage HelloWorld(TestApiArgEntity arg)
            {
                //TODO 具体业务实现
            }
        }

        /// <summary>
        /// 用于测试API的参数实体
        /// </summary>
        public class TestApiArgEntity : BaseParameterEntity
        {
            /// <summary>
            /// ID
            /// </summary>
            public int Id { get; set; }

            /// <summary>
            /// 特征码
            /// <value>A-区域001 B-区域002</value>
            /// </summary>
            public string Code { get; set; }

            /// <summary>
            /// 开始时间
            /// </summary>
            public DateTime StarTime { get; set; }
        }