YOUTRUST WebチームのAPI設計例の紹介 - YOUTRUST Tech Blog

こんにちは！YOUTRUSTでWebエンジニアをしている大竹（YOUTRUST）です。 9月も中旬ですが、まだまだ残暑が続いていますね。引き続き体調管理に気をつけていきたいと思います。 本日のテーマ 以前のブログで開発フローについて軽く触れたのですが、本日はその内容を掘り下げて、API設計（設計書）についてお話しします。 tech.youtrust.co.jp 設計書の作成について 前提として設計書は以下の目的で作成しています。 実装後のコードレビューで大きな手戻りが発生しないようにする コードレビューでエンドポイントの変更などが発生すると、大きな手戻りになってしまい、実装が無駄になってしまう可能性があります。 そのため、設計のタイミングでエンドポイント等を事前にレビューすることで、大きな手戻りが発生しないようにしています。 設計内容を元に細かいタスクに分割することで実装に着手しやすくする