【読書会メモ】現場で役立つシステム設計の原則(8)

実施日時:2020/3/4
対象範囲:第8章
参加者:yodai、くめごん、まぶり、kassyi

WebAPIのエラー時の約束
システムの内部ではエラーについての情報をログなどで時系列で残す。
良いWebAPIとは何か
APIとして大は小を兼ねるものは利用者側にとって負担が大きい。
使いにくいAPIとなるのは、お互いの理解が不足したまま開発が進んでしまうため。
動作させると使用の不整合や考慮漏れなどが発覚するので、作りながら確認していくのが効率的
詳細設計を作成するのは大変なので、基本設計レベル(コア)だけ作成して
詳細設計の代わりにソースコードを作った方が早い
ソースコードからドキュメントを自動生成できるSwaggerなどを使用するとAPIドキュメントを簡単に作れる。
また、APIを先に決めて動作を確認できるツールとしても使える。

この記事が気に入ったらサポートをしてみませんか?