APIリファレンスを 読み込むと楽しい

きたく.dev #1 の登壇資料です。

Transcript

1. APIリファレンスを 読み込むと楽しい yuhi 2026/2/6@きたく.dev
2. 自己紹介 yuhi 株式会社プレックス • バックエンド / Rails書いてます • 北区でもないし、帰宅導線でもない 市川市妙典在住 • 東葛.dev 出⾝ • BuriKaigi2026 のご縁でやってきました🙌
3. 皆さんの帰宅のお供は何でしょう？
4. もちろんAPIリファレンスですよね
5. APIリファレンスとは？
6. ソフトウェアが公開している API仕様書と定義します
7. こんなのとか（ Rails, MDN, Go）
8. 読んだことあるよって方 🙋
9. APIリファレンスを読み込んでおり その取り組みを紹介したい
10. まずは自分の興味が沸く ソフトウェア / OSSを見つけよう
11. 自分の場合は Ruby on Rails
12. 2パターンの読み込み方
13. 基本編 と 深掘り編
14. 基本編
15. 基本編 • APIリファレンスを読む • 所感をメモる
16. 具体例
17. APIリファレンスを読んで
18. 所感をメモる
19. 基本編のメリット・デメリット • メリット ◦ APIあたりにかかる時間が短い ◦ 網羅的にインデックスを貼ることができる • デメリット ◦ 退屈になりやすい
20. 深掘り編
21. 深掘り編 1. 実装・テストを読む 2. git blameを見る 3. コントリビュートする
22. 1. 実装・テストを読む
23. 裏側の仕組みを知れて 知的好奇心を満たせる
24. 設計や実装の学びも多い
25. テストを読むと実装者の意図がわかって よりAPIの解像度が上がる
26. 2. git blameを読む
27. そのAPIの背景が見えてくる
28. 普段意識しないような パフォーマンスの観点で修正が加えられたり
29. 優秀なエンジニア達のディスカッションを覗ける
30. 3. コントリビュートする
31. 実装やblameまで読むと
32. APIリファレンスに コントリビュートする材料が揃う
33. typoやマークアップ漏れや
34. APIの変更後にリファレンスが適切に 更新されていなかったり
35. 内部APIが誤ってリファレンスに 露出されてしまっていたり
36. 何か違和感を感じたらコントリビュートしよ う
37. コントリビュータ、メンテナー 利用者 の三方よしな取り組み
38. 基本的に喜ばれます！！！
39. 深掘り編のメリット・デメリット • メリット ◦ 普段知れない知識に出会えることも多い ◦ コントリビュートチャンスも増える • デメリット ◦ めちゃくちゃ時間がかかる
40. そもそも始めたきっかけは
41. 学習のためというのもあるが
42. カンファレンス登壇がしたい
43. 全部読んでみた系 や コントリビュートでネタを作るのが野望
44. これからの AI時代 人間が開発のボトルネックになると 言われています
45. APIリファレンスを読んで読解の体力をつ けましょう 💪
46. 帰宅のお供に リファレンス、どうでしょう？