OpenAPI 仕様（OAS）とは
OpenAPI 仕様（OpenAPI Specification, OAS）は、REST API のインターフェースを プログラミング言語に依存しない形 で記述するための標準仕様です。
API の入出力やエンドポイントを OAS で定義しておくと、人間もコンピュータも、ソースコードや追加ドキュメント、ネットワークトラフィックの解析なしにその API の機能を理解できます。適切に定義されていれば、利用側は最小限の実装で API を呼び出せるようになり、「このパラメータは何だろう？」といった当て推量が不要になります。
もともとは Swagger という名前でしたが、3.0 へのバージョンアップ時に OpenAPI Specification（OAS）へと改称されました。ただし、周辺ツールの多くは今も "Swagger" の名前を冠しています。
Swagger のツール群
OAS を扱うためのツールは充実しており、設計・可視化・コード生成まで一通り揃っています。
オープンソースツール
-
OpenAPI 仕様で API を設計するためのエディタ。左に定義、右にプレビューが出る。
-
OAS 定義を、実際に叩ける対話的な UI として可視化する。
-
OAS 定義からサーバースタブやクライアント SDK を自動生成する。
有償ツール
-
チームや個人向けの API 設計・ドキュメント管理プラットフォーム。
個人利用なら無料プランがあります。価格はこちら。
-
ブラウザから API を手軽にテストし、その結果から OAS 定義を生成できる。