読者です 読者をやめる 読者になる 読者になる

Hejdaの見る夢

一人前のエンジニアを目指して頑張ったこととかをつらつら書くブログ

Web APIの現場あるある解決特集〜こうして僕たちのAPIは使いやすくなった〜

議事録 議事録

登壇者

WebAPIの現場あるある解決特集〜こうして僕たちのAPIは使いやすくなった〜

  • web apiの悩み

    • 仕様が統一してない
  • レスポンスにどこまで含む

    • フロントの改修ではなく、APIで改修する??
      • レスポンス加工は留めない
    • APIはリクエストに応じた必要なレスポンスのみを返すことに留める
    • APIから受け取ったデータをどのように加工したり使うかは利用側が決める
    • でも、APIでやったほうがいいもの
      • DBを再度参照するもの
        • DB負荷を考えて
      • 複雑なロジックを用いて取得・判定するデータ
        • 権限系
  • RESTにこだわったほうがいいの?

    • URLを見ただけでは何のAPIか分からない
      • 場合によってはリクエストパラメータで実装したほうがシンプルになる
    • ログインユーザ関連API
      • /api/v1/user/1/withdrow
      • /api/v1/me/whithdrow
    • 結論
      • シンプルで分かりやすいAPI
      • APIで判別出来るデータはリクエストパラメータに含めない
  • 画面に必要なデータはどうするか

    • 1スクリーン1APIコール
      • 利便性が高い
      • APIのリクエストの軽減
      • 例外もある
        • 取得するデータによって
    • 1セーブ1APIコール
  • エラーの返し方
  • ページング用のAPIは必要か
    • デモ
  • まとめ
    • APIのルールを決めて、準拠する
    • 利用側に依存しすぎない
    • シンプルで分かりやすいを追求