ohbarye https://blog.hatena.ne.jp/ohbarye/ valid,invalid https://ohbarye.hatenablog.jp/ API Web OpenAPI 先日登壇したイベントにて、仕事で協業したモバイルエンジニアから「Web APIのドキュメントに使われ方の想定が添えられていてありがたかった」とフィードバックをもらった。 具体的にはX post (以下、tweet) に添付した画像のような感じで、Web API (以下、API) が呼び出される画面・タイミングの想定、レスポンスの使われ方の想定などをUIのスクショとともに記述する、というもの。 API設計時にこういう使われ方の想定を添えると認識揃えやすくてありがたい、とモバイルエンジニアに喜ばれました#B43_techtalk pic.twitter.com/XLB3g6fCLZ— ohbary… 190 <iframe src="https://hatenablog-parts.com/embed?url=https%3A%2F%2Fohbarye.hatenablog.jp%2Fentry%2F2023%2F08%2F06%2Fweb-api-communication" title="Web API設計時に使われ方の想定を添えると良い。けどより良いやり方を知りたい - valid,invalid" class="embed-card embed-blogcard" scrolling="no" frameborder="0" style="display: block; width: 100%; height: 190px; max-width: 500px; margin: 10px 0px;"></iframe> https://cdn-ak.f.st-hatena.com/images/fotolife/o/ohbarye/20230806/20230806130156.png Hatena Blog https://hatena.blog 2023-08-06 13:10:15 rich https://ohbarye.hatenablog.jp/entry/2023/08/06/web-api-communication 1.0 100%