597      阿裏雲  技術社區[雲棲]

OBJECTC SDK 使用手冊__使用SDK調用已開放API_SDK_API 網關-阿裏雲

1. 前言

本套程序是阿裏雲API網關團隊提供給用戶的API網關的HTTP底層通訊SDK，適用於在移動端調用已接入API網關的私有、公開API以及目前在數據市場上售賣的API。

本SDK實現了API網關的簽名算法和一係列Http調用，解決用戶的HTTP通訊問題，用戶可以在本SDK上層包裝自己的API。我們同時提供了封裝好的framework形式的第三方庫和源碼。

如果您有定製化需求，可以直接把源碼下載到你的項目中修改後使用；如果您隻是簡單的調用，直接使用我們提供封裝好的framework版本即可。

源碼所在地址為https://github.com/aliyun/api-gateway-demo-sign-objectc，源碼的細節請點擊進去查看。

本SDK具體提供了一下五種HTTP通訊接口：

• Http Get
• Http Post Form
• Http Post Bytes
• Http Put Bytes
• Http Delete

封裝好的framework的SDK在CloudApiSdk.framework文件夾內，文件的結構：

• CloudApiSdk.framework
  • CloudApiSdk 封裝好的SDK二進製文件，可同時在模擬器和真機中運行
  • Headers文件夾 可直接調用的頭文件
    • AppConfiguration.h SDK的配置設置
    • CloudApiSdk.h Http工具類，負責發送HTTP請求
    • HttpConstant.h Http常量類

本封裝好的SDK隻支持iOS 6.0以上的平台。

2. 安裝API網關 OBJECTC SDK

2.1 下載SDK

在API網關控製台左側找到SDK及示例菜單，點擊前往SDK下載頁麵。

根據頁麵提示查看使用手冊或者前往下載SDK。需要注意區分代碼示例及SDK，代碼示例適用於不準備使用SDK的用戶參考代碼完成API調用工作，而SDK可以幫助用戶簡化API調用工作。

點擊前往下載SDK鏈接後，瀏覽器會打開新頁麵，該頁麵為阿裏雲移動服務的SDK下載頁麵。在下載頁麵上勾選API網關，然後點擊下載iOS版按鈕，根據頁麵提示下載到API網關的OBJECTC SDK。

2.2 把SDK引入你的項目

您可以像引用其他第三方庫一樣引入本SDK到您的項目中去：

1, 把SDK的”CloudApiSdk.framework”文件夾下載到本地，複製到項目放置第三方的文件夾內；

2, 用Xcode打開iOS項目，點擊”TARGETS”->”項目名稱”->”Build Phases”->”Link Binary With Libraries”->”+”；

3, 在彈出來的選擇Tab頁中點擊左下角的”Add Other…”，然後選擇剛才複製進項目的”CloudApiSdk.framework”文件夾。

引入成功後可以在項目的Frameworks看到剛才添加進去的”CloudApiSdk.framework”，點擊進去看，可以看到本文上麵提到的三個頭文件。

2.3 工程中引入頭文件

#import <CloudApiSdk/CloudApiSdk.h>

2.4 初始化SDK

本SDK需要將你的AppKey和AppSecret初始化後，才能正常使用，初始化的語句參考Demo/ApiClient.m的init方法：

- (instancetype)init {
    self = [super init];
    if (self) {
        [[AppConfiguration instance] setAPP_KEY:@""];
        [[AppConfiguration instance] setAPP_SECRET:@""];
    }
    return self;
}

2.4 調用SDK

然後可以調用CloudApiSdk類發送各種類型的Http請求:

2.4.1 API的包裝類ApiClient調用CloudApiSdk實現HTTP通訊

- (void) sendHttpGetDemo:(NSInteger) userId
                 sex:(NSString *) sex
                 age:(NSInteger) age
     completionBlock:(void (^)(NSData * , NSURLResponse * , NSError *))completionBlock
{
    //定義Path
    NSString * path = @"/v3/getUserTest/[userId]";
    //定義PathParameter
    NSMutableDictionary *pathParams = [[NSMutableDictionary alloc] init];
    [pathParams setValue:[NSString stringWithFormat:@"%ld" , userId] forKey:@"userId"];
    //定義QueryParameter
    NSMutableDictionary *queryParams = [[NSMutableDictionary alloc] init];
    [queryParams setValue:sex forKey:@"sex"];
    //定義HeaderParameter
    NSMutableDictionary *headerParams = [[NSMutableDictionary alloc] init];
    [headerParams setValue:[NSString stringWithFormat:@"%ld" , age] forKey:@"age"];
    [[CloudApiSdk instance] httpGet: CLOUDAPI_HTTP
                               host: HOST
                               path: path
                         pathParams: pathParams
                        queryParams: queryParams
                       headerParams: headerParams
                    completionBlock: completionBlock];
}    

2.4.2 界麵調用ApiClient實現業務邏輯

- (IBAction)SendGetRequestAction {
    [[ApiClient instance] sendHttpGetDemo:10000094
                                      sex:@"boy"
                                      age:18
                          completionBlock:^(NSData * _Nullable body , NSURLResponse * _Nullable response, NSError * _Nullable error) {
                              dispatch_async(dispatch_get_main_queue(), ^{
                                  NSString *bodyString = [[NSString alloc] initWithData:body encoding:NSUTF8StringEncoding];
                                  [[ResultModel instance] setResultString:[NSString stringWithFormat:@"Http Get Response object:%@nHttp Get Response Body:n%@" , response , bodyString]];
                                  [self performSegueWithIdentifier:@"getResultSegue" sender:nil];
                              });
                          }];
}

3. 調用示例

本SDK提供圖形調用示例給大家參考，調用示例代碼說明如下在：https://github.com/aliyun/api-gateway-demo-sign-objectc/tree/master/sdk/demo，調用代碼的說明如下。