エンジニア戦記〜小さなチーム、大きな未来〜

平井祐樹
２９
２０１１/2 Classmethod入社
iOS 開発歴２年半
blog http://dev.classmethod.jp/author/hirai-yuki

って何の会社？クラスメソッド

Solutions
AWSコンサルティング
Amazonクラウドに特化したサービス提供
iOSアプリ開発
iOS/Android ネイティブアプリケーション開発

Developers.IO

Developers.IO
月間平均 80 万PV

こんな感じでしょ？

こんな感じです。

注：テーブルのお札はおもちゃです

プロジェクト登場人物
デザイナー
プロダクトオーナー
Web API担当者
iOS エンジニア

今日のお話
Web API担当者iOS エンジニア

今日のお話
Web API との付き合い方
Web API 担当者ヲ攻略セヨ

突然ですが…

プロジェクトに
参加してもらいます

イメージしてみてください

今あなたはとあるプロジェクトの
iOSエンジニアとしてアサインさ
れました。
その一方で、
サーバーサイドエンジニアが
WebAPIの実装をしています。

Web API 完成 ?

iOSの実装を進めていたあなたは
と、日頃の戦いに疲れきっている
のにも関わらずちょっと元気がで
ます。
「よし！これで結合できるぞ！」

おもむろに仕様書に目を通すと

{
"header": {
"status": "success",
"message": "..."
},
"response": {
"topics": [{
"topic_id": 123,
"topic_title": "...",
"topic_content": "...",
"category_id": 456,
"category_name": "..."
}]
}
}

あなたは気づいてしまいます。

{
"header": {
"message": "..."
},
"response": {
"topics": [{
"topic_id": 123,
"category_id": 456,
}]
}
}
HTTPステータスコードで
表してくれればいいのに！

このままだと…

AFHTTPRequestOperationManager *manager;
[manager GET:@"http://xxx.com/possts"
parameters:nil
success:^(...) {
// 成功時の処理
} failure:^(...) {
// 失敗時の処理
}];
エラーが発生しても
こっち

さらに

{
"header": {
"message": "..."
},
"response": {
"topics": [{
"topic_id": 123,
"category_id": 456,
}]
}
}
いらないのに

@interface CLMTopic : NSObject
@property (nonatomic) NSInteger topicIdentifier;
@property (nonatomic) NSString *topicTitle;
@property (nonatomic) NSString *topicContent;
@end
格好悪いなぁ

あなたは Web API 担当者に
こう提案します。

{
"topics": [{
"id": 123,
"title": "...",
"content": "...",
"category_id": 456,
}]
}

Web API 担当者は内心こう思います。

（ったく、めんどくせぇな・・・）

そんな空気を感じてもあなたは
動じず提案を続けました。

すると、新しいAPIを手に入れる
ことができました！
これで実装への悪影響を回避する
ことができますね。

一安心もつかの間・・・

{
"categories": [{
"id": 456,
"name": "..."
}]
}

また

{
"topics": [{
"id": 123,
"title": "...",
"content": "...",
"category_id": 456,
}]
}
{
"categories": [{
"id": 456,
"name": "..."
}]
}

@property (nonatomic) NSInteger identifer;
@property (nonatomic) NSString *title;
@property (nonatomic) NSString *content;
@property (nonatomic) NSInteger categoryIdentifier;
@property (nonatomic) NSInteger categoryName;
@end
@interface CLMCategory : NSObject
@property (nonatomic) NSInteger identifier;
@property (nonatomic) NSInteger name;
@end
しっくりこない・・・

{
"topics": [{
"id": 123,
"title": "...",
"content": "...",
"category": {
"id": 456,
"name": "..."
}
}]
}

@property (nonatomic) NSInteger identifer;
@property (nonatomic) NSString *title;
@property (nonatomic) NSString *content;
@property (nonatomic) CLMCategory *category;
@end
@interface CLMCategory : NSObject
@property (nonatomic) NSInteger identifier;
@property (nonatomic) NSInteger name;
@end

（ああーーあーあーー）

変な空気を感じながらも
あなたは提案を続けました。

すると、また新しいAPIを手に入
れることができました！
これでまた実装への悪影響を回避
することができますね。

目的エンドポイント
トピック一覧取得 https://api.xxx.com/v1/topics/
カテゴリー一覧取得 https://api.xxx.com/v1/categories/
おすすめ商品取得 https://api.xxx.com/v1/products/recommend
ユーザー情報取得 https://api.example.com/v1/user/

またまた

ホーム画面
カテゴリー一覧取得API
おすすめ商品一覧API
ユーザー情報取得API
トピック一覧取得API

ホーム画面
カテゴリー一覧取得API
おすすめ商品一覧API
ユーザー情報取得API
トピック一覧取得API
１画面表示するのに
何個API叩きゃいいんだ！？

1 Screen, 1 API call

Web API 担当者は言いました。

「Ha?」

あなたは続けます

１画面を表示するのに、何度も異なるAPIにアクセ
スしなければならず、非効率ですし、画面を表示す
るまでに時間もかかってしまい、ユーザーを待たせ
てしまいます。これは良いユーザー体験とはいえま
せん。何度もAPIへのアクセスを繰り返すことは、
速度の問題だけでなく、データの一部だけが表示さ
れてしまうといった問題を引き起こす可能性もあり
ます。したがってとにかくホーム画面で表示する情
報を１つに詰め込んだ "ホーム画面専用" APIを作
成し、それに１回アクセスするだけですべての情報
が取得できた方が確実に利便性が高いです。
詳しくは "Web API The Good Parts" をご覧ください。

「・・・なるほどですね」

なるほどですね！

その言葉を聞いてあなたは
実装に戻りました。

すると、またまた新しいAPIを手
に入れることができました！
これでまたまた実装への悪影響を
回避することができますね。

こうして、
プロジェクトは順調に進み無事納
品することができたのでした。

まとめ
• Web API の知識は必須！
• Web API The Good Parts を読もう！
• 文句を言うのは簡単、改善案を提案
できる力を！

エンジニア戦記〜小さなチーム、大きな未来〜

エンジニア戦記 〜小さなチーム、大きな未来〜

More Related Content

Viewers also liked

Similar to エンジニア戦記 〜小さなチーム、大きな未来〜