IDL Definition Specification for Mapping between Thrift and HTTP

struct Item{
    // For nested structures, if you want to set the serialization key, use gotag, such as `json: "Id"`
    1: optional i64 id(go.tag = 'json:"id"')
    2: optional string text
}
typedef string JsonDict
struct BizRequest {
    // Corresponding to v_int64 in HTTP query, and the value range is (0, 200)
    1: optional i64 v_int64(api.query = 'v_int64')
    2: optional string text(api.body = 'text') // Corresponding serialization key = text
    3: optional i32 token(api.header = 'token') // Corresponding token in HTTP header
    4: optional JsonDict json_header(api.header = 'json_header')
    5: optional Item some(api.body = 'some') // Corresponding first level key = some
    6: optional list<ReqItem> req_items(api.query = 'req_items')
    // api.query Only list split by are supported,Other complex types are not supported
    7: optional i32 api_version(api.path = 'action') // Corresponding path in uri
    8: optional i64 uid(api.path = 'biz') // Corresponding path in uri
    9: optional list<i64> cids(api.query = 'cids')
    // Corresponding to comma separated numbers in query, for example: cids=1,2,3,4 Only supported list<i64>、list<i32>
    10: optional list<string> vids(api.query = 'vids')
}

// Finally, BizResponse json will be serialized as a return package to the client
struct RspItem{
    1: optional i64 item_id // By default, it is serialized with the field name as key, which is equivalent to using gotag `json:"item_id"`
    2: optional string text
}
struct BizResponse {
    // This field will be filled in the header returned to the client
    1: optional string T  (api.header= 'T')
    // first level key = 'rsp_items'
    2: optional map<i64, RspItem> rsp_items  (api.body='rsp_items')
    3: optional i32 v_enum  (api.none = 'true') // Ignore current parameter
    4: optional list<RspItem> rsp_item_list  (api.body = 'rsp_item_list')
    // The business specifies the HTTP Code itself. If not specified, baseResp.StatusCode=0 -> HTTPCode=200,  other HTTPCode=500
    5: optional i32 http_code  (api.http_code = 'true')
    6: optional list<i64> item_count (api.header = 'item_count') // Comma separated list when setting header
    7: optional string token (api.cookie = 'token') // 对应 response Cookie 字段
}

service BizService{
    // Example 1: get request
    BizResponse BizMethod1(1: biz.BizRequest req)(
        api.get = '/life/client/:action/:biz',
        api.baseurl = 'ib.snssdk.com',
        api.param = 'true',
        api.category = 'demo'
    )

    // Example 2:   post request
    BizResponse BizMethod2(1: biz.BizRequest req)(
        api.post = '/life/client/:action/:biz',
        api.baseurl = 'ib.snssdk.com',
        api.param = 'true',
        api.serializer = 'form'
    )

    // Example 3:   delete request
    BizResponse BizMethod3(1: biz.BizRequest req)(
        api.post = '/life/client/:action/:biz',
        api.baseurl = 'ib.snssdk.com',
        api.param = 'true',
        api.serializer = 'json'
    )
}