# sdk-csharp

C#对应的SDK，由于本人使用mac开发，因此使用了.Net Core

测试用例在`Program.cs`


## 接口封装步骤

比如获取故事信息接口

- 接口名：product.get
- 版本号：1.0
- 参数：id
- 返回信息

```
{
    "code": "0",
    "msg": "success",
    "sub_code": "",
    "sub_msg": "",
    "data": {
        "id": 1,
        "name": "冰 箱 -env=gray",
        "gmt_create": null
    }
}
```

针对这个接口，封装步骤如下：

1.在`Model`包下新建一个类，定义业务参数

```
namespace SDKCSharp.Model
{
    public class GetProductModel
    {

        /// <summary>
        /// id
        /// </summary>
        /// <value>The id.</value>
        [JsonProperty("id")]
        public int Id { get; set; }
    }
}
```

`[JsonProperty("name")]`是Newtonsoft.Json组件中的类，用于Json序列化，括号中的是参数名称。
类似于Java中的注解，`@JSONField(name = "xx")`

2.在`Response`包下新建一个返回类GetProductResponse

里面填写返回的字段

```
namespace SDKCSharp.Response
{
    public class GetProductResponse
    {
        [JsonProperty("id")]
        public int Id { get; set; }

        [JsonProperty("name")]
        public string Name { get; set; }

        [JsonProperty("gmt_create")]
        public string GmtCreate { get; set; }

    }
}
```

3.在`Request`文件夹下新建一个请求类，继承`BaseRequest`

BaseRequest中有个泛型参数，填`GetStoryResponse`类，表示这个请求对应的返回类。
重写`GetMethod()`方法，填接口名。

如果要指定版本号，可重写`GetVersion()`方法，或者后续使用`request.Version = version`进行设置

```
namespace SDKCSharp.Request
{
    public class GetProductRequest : BaseRequest<GetProductResponse>
    {
        public override string GetMethod()
        {
            return "product.get";
        }
    }

}
```



## 使用方式

```
class MainClass
{
    static string url = "http://localhost:8081/api";
    static string appId = "2019032617262200001";
    // 平台提供的私钥
    static string privateKey = " ";


    // 声明一个就行
    static OpenClient client = new OpenClient(url, appId, privateKey);

    public static void Main(string[] args)
    {
        TestGet();
    }

    // 标准用法
    private static void TestGet()
    {
        // 创建请求对象
        GetProductRequest request = new GetProductRequest();
        // 请求参数
        GetProductModel model = new GetProductModel();
        model.Id = 1;
        request.BizModel = model;

        // 发送请求
        Result<GetProductResponse> result = client.Execute(request);
      
        if (result.IsSuccess())
        {
            // 返回结果
            Console.WriteLine("成功！response:{0}\n响应原始内容:{1}", JsonUtil.ToJSONString(result), result.Data);
        }
        else
        {
            Console.WriteLine("错误, code:{0}, msg:{1}, subCode:{2}, subMsg:{3}",
                result.Code, result.Msg, result.SubCode, result.SubMsg);
        }
    }

    
}
```
