API Design Discussion — The team lead
Situation
場面- Where
- A backend sync
- Who
- You and the team lead
- Goal
- To agree on an API contract.
Conversation
会話A
登録フォームのAPIのレスポンス形式を相談したいです。
とうろくふぉーむのえーぴーあいのれすぽんすけいしきをそうだんしたいです。
tourokufoomunoeepiiainoresuponsukeishikiosoudanshitaidesu.
I'd like to discuss the response format for the the registration form API.
B
いいですね。ページネーションは必要ですか。
いいですね。ぺーじねーしょんはひつようですか。
iidesune. peejineeshonhahitsuyoudesuka.
Sure. Do we need pagination?
A
はい、件数が多いので入れた方がいいと思います。
はい、けんすうがおおいのでいれたほうがいいとおもいます。
hai, kensuugaooinodeiretahougaiitoomoimasu.
Yes, there are many records, so I think we should include it.
B
では、その方向で進めましょう。
では、そのほうこうですすめましょう。
deha, sonohoukoudesusumemashou.
Then let's go in that direction.
A
ありがとうございます。仕様書にまとめておきます。
ありがとうございます。しようしょにまとめておきます。
arigatougozaimasu. shiyoushonimatometeokimasu.
Thanks. I'll write it up in the spec doc.
Vocabulary
単語レスポンスれすぽんす
resuponsu
response
What the API returns.
形式けいしき
keishiki
format
レスポンス形式 = response format.
ページネーションぺーじねーしょん
peejineeshon
pagination
Splitting results into pages.
件数けんすう
kensuu
number of records
件数が多い = "many records."
方向ほうこう
houkou
direction
その方向で進める.
仕様書しようしょ
shiyousho
spec document
Where the API contract is written.
Grammar
文法〜たいです
Verb stem + たいです
Expresses a wish: 相談したいです.
〜ので
Plain form + ので
Reason: 多いので.
Cultural Notes
文化メモAgree on contracts
Settle the API shape before both sides build against it.
Document decisions
Writing it in the spec doc prevents later disputes.
Quiz
クイズ1. 「レスポンス」の意味は？
What does "レスポンス" mean?
2. 「形式」の意味は？
What does "形式" mean?
3. 「ページネーション」の意味は？
What does "ページネーション" mean?
4. 「件数」の意味は？
What does "件数" mean?
5. 「方向」の意味は？
What does "方向" mean?
6. 「仕様書」の意味は？
What does "仕様書" mean?