PHP-BLT#2で発表したスライドです

1. PHP BLT #2
@rittyan
今更Cake2.3で
WebAPI作った話

2. 人生初ＬＴ

3. 自己紹介
NEETを脱出して働き始めてから大体2年弱
最近お仕事でやってること
• 見積
• 実装
最近勉強してる言語はOCaml
twitter : @rittyan
• 打ち合わせ
受託系の企業で働いてます

4. 半年ぐらい前に
WebAPIを作って
リリースしました
Cake 2.3で

5. なんでCake2.3だっ
て？

6. 大人の事情です

7. リリースしてから
半年ぐらい経ったので

8. やってよかったこと
駄目だった事を
話そうと思います

9. 実装するにあたって
参考にしたもの

10. Web API :
The Good Parts
• だいたいこれ読んでおけば
よいと思う
• 迷った時はGitHubとか
TwitterのAPIDocumentを
みて、先人達の知恵を学ぶ

11. 駄目だった事

12. バージョニング

13. バージョニング
• 大規模な改修毎に2、3とあげて小規模な修正には小数点以下であげ
ますとかやってしまった
• 定期的に大規模改修があればいいけど、大規模改修が頓挫する可能
性も考えるとそういう風にバージョニングの意味をつけないほうが
いい
• 1.9までいっちゃったらどうすんの？とかある
• 整数のが悩まないですむ
• if(API_VERSION <= 1.4) とかやってて微妙な気分

14. エラーコード

15. エラーコード
• データ取得系で何もなかった場合204を返すようにしてしまった
• レスポンスに0件とか加えればよかったんじゃ？
• そもそもレスポンスのフォーマットが…(後述)
• ちなみに204で返すとブラウザアドオンのAPIClientは中身空にする
ので204を返しつつ何かレスポンスを返したい時は確認手段に注意
• 独自エラーコードは実装しなかった(後で危なくなりそうだから)

16. レスポンス

17. レスポンス
• JSON形式だけど階層にはなってない
• user : {id : 1}とかじゃなくて user_id、user_nameみたいな感じで一
つの階層に存在する形式
• 気づいた時には大人の事情でもうレスポンス形式を変えるには遅す
ぎた
• アプリ側はつらそう

18. やってよかったこと

19. テスト書いた

20. プルリクベースで
コードレビューしながら
進めた

21. 未だに悩んでる事

22. ページネーション

23. ページネーション
• ページネーション
• 一応 limit、offset、時刻形式でページネーションするようにした
• けどデータを更新順で並べたりするため、位置が悪いと出てこなく
なる
• 主キーで絞るのがいいのではないかと思うけど、
そのあたりのベストプラティスが欲しい

24. 統括

25. 統括
• テストは作ろう 未来の自分の助けになる
• 知識としてはオライリーの本をベースにインプットしつつ、
最新サービスのDocumentをみて流行りとか動向を押さえておくと
よさげ
• RESTFulでなくてもいい
• 一度アプリ作ってみるとAPIを使う側の気持ちになれてよい
• 迷ったらシンプルに、わかりやすくを合言葉に

26. 感想

27. PHPはもういいや最高！！！

28. 終
ご静聴ありがとうございました