https://sansan.connpass.com/event/49960/ にて発表

1. 成長するサービスを
支えるAPI管理
Eightを支える技術
2017/02/24 @Sansan Garden
Sansan株式会社 Eight事業部 大熊

2. Eight歴：4年目（2014.01〜
担当領域：インフラ以外
最近の関心ごと：家ホッピー

3. 今日伝えたいこと

4. 成長するサービスのAPIを
どうメンテしてきたか
（いきたいか）

5. これまでのEight

6. 名刺管理
Business SNS
Eight内検索
レコメンド
名刺管理
Growth
プレミアム機
能
フィード
プロフィール公
開
企業ページ

7. 名刺管理
Business SNS
Eight内検索
レコメンド
名刺管理
Growth
プレミアム機
能
フィード
プロフィール公
開
企業ページ
自分が所有する名刺情
報をいかに管理・活用す
るか
ネットワーク内（自分の所
有する名刺を超えていく）
でコミュニケーションを行う

8. 常にモバイルアプリが先行
（あるいはwebと同時）

9. Web
アプリ
プレミアムになるとcsvで名刺
をDLできるが、それは
webにしかない

10. Eightでは常にアプリ開発と
API開発が並行する

11. 企画キックオフ
API設計
アプリ開発着手
API定義
API実装
（あるいはモック実装
随時フィードバック
あるいはバグ報告
Productionリリース
アプリ申請＆リリース
アプリ開発
AP提供
サ
ー
バ
チ
ー
ム
ア
プ
リ
チ
ー
ム

12. サービス成長を支えるAPIに
必要なことは？

13. 機能追加しやすい
(でも後方互換も守る)
端末チームが開発しやすい

14. 画像、投稿シェア、リンクシェア、名刺追加、職
歴更新、利用開始、プロフィール更新 …

15. 機能追加しやすい
(後方互換も守る)

16. APIが拡張されていく

17. アプリチームに協力してもらう

18. 固定部分と変動部分に分ける

19. 投稿者情報
投稿時刻
種別
…
投稿詳細
フィード

20. 種別 アプリVersion XXX アプリVersion YYY
画像投稿 ○ ○
シェア投稿 ○ ○
利用開始投稿 未対応 => skip ○
プロフィール更新投稿 未対応 => skip ○
名刺投稿 ○ ○

21. 回避できなかったケース

22. 既存の投稿を拡張したい

23. 種別 アプリVersion XXX アプリVersion YYY
画像投稿 ○ ○
シェア投稿 ○ ○
利用開始投稿 未対応 => filter ○
プロフィール更新投稿 未対応 => filter ○
名刺投稿 ○ ○

24. 固定部分と変動部分に分ける

25. 利用しやすいAPI

26. 懺悔が続きます🙇

27. 同じものは同じ名前で同じ属性で
返す

28. 当たり前では？

29. API実装：
表示仕様をみると不要みたいだしこのAPIではXXX属性
はつけなくて良いか。
クエリも減らせるしなぁ
アプリ実装：
属性が同じでキーも同じならば常にローカルのDBを更新
してた

30. 🐛 フィードの詳細画面にいってか
ら一覧に戻るとコメントが常に消
える 🐛

31. 新しめの人：
フィードの投稿者の情報とプロフィールページの情報って
何か違うんですかね？
古株（老害）：
これには歴史的経緯があってだな。。。

32. サービスの成長とともに、よりふさわしい概
念が生まれることがある

33. 同じものは同じ名前で同じ属性で
返す

34. 型、空白表現を揃える

35. 当たり（ry

36. この属性ってnull返ってくることあるんです
か？
数値属性なのに文字列で返ってきちゃっ
てます
intだけど空白表現が空文字列…

37. APIパス、HTTPメソッド、パラメータの型、フォー
マット、デフォルト値、null or keyなし、必須値、最
大値、最小値、、

38. 仕様のyml仕様サイト
仕様変更PR
API実装者
リクエストも
送れちゃう！
ymlを参照
アプリチーム
仕様閲覧

39. APIパス、HTTPメソッド、パラメータの型、フォー
マット、デフォルト値、null or keyなし、必須値、最
大値、最小値、、

40. 表現できないからレビューもでき
ない（気づきにくい

41. これからの話をします

42. 結論

43. swagger使います
(Open API)

44. 秩序を取り戻したい

45. 同じものを同じ名前で同じ属性で返したい（定
義したい
仕様のブレをなくしたい

46. なぜswaggerか？

47. リソースを個別に定義できる
json-schema
API仕様あるあるを一通り定義できる言葉が
ある
各種ツール（エディタとかモック生成とか

48. リソースを個別に定義できる
json-schema
API仕様あるあるを一通り定義できる言葉が
ある
各種ツール（エディタとかモック生成とか

49. 表現できるからレビューできる

50. まとめ

51. 成長を支える拡張性（後方互換）と一貫性
表現力のあるレビュー可能な仕様書
大事なこと

52. おしまい