OpenAPI — Termwire

REST APIの仕様を、人にもプログラムにも理解できる共通の書式で記述する標準規格。

APIがどんなエンドポイントを持ち、どんなデータを受け取り返すのかを、決まった書式のファイルに定義しておく。この定義から、APIの説明書やテスト用の画面を自動的に生成できる。

この規格に沿って仕様を定義しておくことで、フロントエンドとバックエンドの担当者間での仕様のすり合わせがスムーズになる。