実践!Swift API Design Guidelinesに基づいた簡潔明瞭なAPIの作り方 by 西 悠作

iOSDC Japan 2023
レギュラートーク(20分)

実践!Swift API Design Guidelinesに基づいた簡潔明瞭なAPIの作り方

jrsaruo_tech 西 悠作 jrsaruo_tech
8

自分や同僚の作ったメソッド、何が起きるか分かりづらい…コードが読みにくい…そんな経験ありませんか?

本トークでは、SwiftのAPI Design Guidelines(ADG)が示すAPIの理想像を整理したうえで、実際のコード例をもとに

  1. 改善点の分析
  2. 適用できるADG項目の解説
  3. 2に基づいた書き換え(ADGにはない工夫も!)

を繰り返し、API設計での大事な観点をまとめます。
ADGに沿ってAPIを改善する過程とその効果を体感し、今後のコーディングやコードレビューにご活用ください。

メソッド名から引数ラベル、返り値型に至るまで、APIの構成要素すべてを洗練させ、簡潔明瞭で美しいAPIをデザインしましょう!

こんな方におすすめ:

  • ADGを読んだことがない/活用できていない
  • コードの可読性についてよく指摘を受ける

やらないこと:

  • ADGを全て読む