外部APIとズブズブな開発どうしてますか？

PHPカンファレンス沖縄2023 トラックB 12:00~

Transcript

1. 外部APIとズブズブな開発
   どうしてますか？
   志賀彩乃(@kin29ma_n)
   

   View Slide

2. 自己紹介
   ● 志賀彩乃(@kin29ma_n)
   ● 株式会社カルテットコミュニケーションズ
   ○ 愛知県名古屋市
   ○ PHPer大募集中です
   ○ 会社に入ってSymfonyはじめました
   ● 趣味: ペチコン/PHPerKaigi行くこと
   ● 息子(3)
   ● 山口→ 宮崎 → 愛知
   

   View Slide

3. 話すこと
   ● API → Web API
   ● 外部APIを使う上での失敗とその対処法
   ○ あるある①: APIアップデートのキャッチアップ漏れ
   ○ あるある②: APIリファレンスに情報が載ってない
   ○ あるある③: 急にAPIやエンドポイントが使えなくなる
   話さないこと󰢄
   ● 外部APIの使用方法
   ● PHPな話
   

   View Slide

4. ではさっそく
   これがベストだと思っていないので、
   良い方法があればぜひ教えてください🙇🙇🙇
   

   View Slide

5. 外部APIを使う上でのあるあるな失敗とその対処法
   ● あるある①: APIアップデートのキャッチアップ漏れ 👈
   ● あるある②: APIリファレンスに情報が載ってない
   ● あるある③: 急にAPIやエンドポイントが使用不可になる
   

   View Slide

6. あるある①: APIアップデートのキャッチアップ漏れ
   BEFORE
   約10個の媒体APIのアップデート情報のキャッチアップを、
   1人のスーパー開発者に依存していました。 ＼本当にありがとうございました 🙇／
   ・G⚫ogle
   ・Yah⚫o Search
   ・Yah⚫o Display
   ・M⚫ta
   ・旧T⚫itter
   ・L⚫NE
   ・TikT⚫k
   ・S⚫rtNews
   ・Micr⚫Soft
   ・fre⚫e
   ・G⚫ogle Analytics
   

   View Slide

7. あるある①: APIアップデートのキャッチアップ漏れ
   AFTER
   約10個の媒体APIのアップデート情報のキャッチアップを、
   月に1回、3人で行う（=1人あたり3~4個）
   ・Yah⚫o Search
   ・旧T⚫itter
   ・S⚫art News
   ・Tikt⚫k
   ・G⚫ogle
   ・L⚫NE
   ・Micr⚫Soft
   ・Yah⚫o Display
   ・M⚫ta
   ・G⚫ogle Analytics
   ・fre⚫e
   

   View Slide

8. あるある①: APIアップデートのキャッチアップ漏れ
   具体的な方法
   ● 新しいAPIバージョンがでていれば、GitHub Issuesを立てる
   ○ キャッチアップの方法
   ■ リリースノート（RSSフィード）
   ■ メール
   ■ → 専用Slackチャンネルに流す
   ● 廃止日やサポート終了日が近いものは優先度高めで対応する
   

   View Slide

9. 外部APIを使う上でのあるあるな失敗とその対処法
   ● あるある①: APIアップデートのキャッチアップ漏れ
   ● あるある②: APIリファレンスに情報が載ってない 👈
   ● あるある③: 急にAPIやエンドポイントが使用不可になる
   

   View Slide

10. あるある②: APIリファレンスに情報が載ってない
    動画(VIDEO)の時のレスポンスしか分からない。
    画像の時のレスポンスが知りたい！
    

    View Slide

11. あるある②: APIリファレンスに情報が載ってない
    対処法
    ● APIを叩く(cURL, Postman等)
    ● 実際にそのAPIを使っているであろう画面にて、デベロッパーツールでリク
    エスト/レスポンスを見る
    

    View Slide

12. あるある②: APIリファレンスに情報が載ってない
    対処法
    ● APIを叩く(cURL, Postman等)
    ● 実際にそのAPIを使っているであろう画面にて、デベロッパーツールでリク
    エスト/レスポンスを見る👈
    

    View Slide

13. あるある②: APIリファレンスに情報が載ってない
    対処法
    ● APIを叩く(cURL, Postman, API Tester等)
    ● 実際にそのAPIを使っているであろう画面にて、デベロッパーツールでリク
    エスト/レスポンスを見る👈
    ○ ①実際にそのAPIを使っているであろう画面の目星をつける
    ○ ②デベロッパーツール > ネットワークを開く
    ○ ③該当APIエンドポイント（または似ているもの）を見つけ、リクエスト/レ
    スポンスを見る
    

    View Slide

14. あるある②: APIリファレンスに情報が載ってない
    ①実際にそのAPIを使っているであろう画面の目星をつける
    例）静止画の編集画面、静止画を表示させている画面など
    ＼推理力／
    

    View Slide

15. あるある②: APIリファレンスに情報が載ってない
    ②デベロッパーツール > ネットワークを開く
    

    View Slide

16. あるある②: APIリファレンスに情報が載ってない
    ③該当APIエンドポイントを見つけ、 リクエスト/レスポンスを見る
    

    View Slide

17. あるある②: APIリファレンスに情報が載ってない
    ③該当APIエンドポイントを見つけ、 リクエスト/レスポンスを見る
    ＼静止画の時のレスポンスも把握できた🎉／
    

    View Slide

18. 外部APIを使う上でのあるあるな失敗とその対処法
    ● あるある①: APIアップデートのキャッチアップ漏れ
    ● あるある②: APIリファレンスに情報が載ってない
    ● あるある③: 急にAPIエンドポイントが使用不可になる 👈
    

    View Slide

19. あるある③: 急にAPIエンドポイントが使用不可になる
    直近でほんとにあった怖い話
    「〇〇の機能が使えません」というお問い合わせをいただく
    →原因調査すると、昨日まで使えてたAPIエンドポイントが急に使えなくなって
    いた。
    

    View Slide

20. あるある③: 急にAPIやエンドポイントが使用不可になる
    対処法
    ● 防ぐことは難しい
    ● 発生した時の解決法
    ○ ログを見る → 「エラーメッセージ」を読む
    ○ 「エラーメッセージ」でググる
    ■ 公式のリリースノートやAPIリファレンス
    ■ 媒体のフォーラム
    ■ GitHub Issues
    ■ 個人サイトの記事
    ○ ChatGPTに聞く
    

    View Slide

21. あるある③: 急にAPIやエンドポイントが使用不可になる
    対処法
    ● 防ぐことは難しい
    ● 発生した時の解決法
    ○ ログを見る → 「エラーメッセージ」を読む
    ○ 「エラーメッセージ」でググる
    ■ 公式のリリースノートやAPIリファレンス
    ■ 媒体のフォーラム 👈
    ■ GitHub Issues
    ■ 個人サイトの記事
    ○ ChatGPTに聞く
    

    View Slide

22. あるある③: 急にAPIやエンドポイントが使用不可になる
    媒体のフォーラムにて同じ状況&解決方法を記載してくれてる方がいた
    →無事解決しました🎉🎉🎉
    ＼超感謝😭！！！／
    

    View Slide

23. まとめ
    ● APIとズブズブなのは手がかかる
    ● APIがないと作れない機能がある
    ○ APIを提供してくれて、ありがとう！
    ● 困った時に助けてくれる人はいる！
    ○ 情報提供してくれた人に感謝を伝えよう！
    

    View Slide

24. まとめ
    ● APIとズブズブなのは手がかかる
    ● APIがないと作れない機能がある
    ○ API提供してくれて、ありがとう！
    ● 困った時に助けてくれる人はいる！
    ○ 情報提供してくれた人に感謝を伝えよう！
    助け合いの世界🤝
    

    View Slide

25. 助けてくれる or 助け合いたいPHPerの方、大募集中です🙌🙌🙌
    https://quartetcom.co.jp/recruit/engineer/
    

    View Slide

26. ご清聴ありがとうございました。
    みなさまのAPI攻略法の共有お待ちしています。
    

    View Slide