auの日記

プログラミング初心者の日記。(auはハンドルネームです)

Swaggerについて調べてみた

auです。

Swaggerというフレームワークについて調べてみました。

swagger.io

Swaggerとは

Swaggerとは、Open APIであり、REST APIの仕様を記述するためのフォーマットを使用するためのフレームワークです。

Swaggerは、jsonyamlで記述されています。そのためエンジニアにとって可読性が高く、統一されている形式のため管理も楽です。

この設計書を読み込み、実際にデータを送受信することでAPIのモックやテストを簡単に行う機能もあるようです。

Swagger UIを使うことで設計書からHTML形式で自動生成することができ、APIを可視化することができます。

デファクトスタンダードなOpenAPIとも言われているようなので、今後触れる機会がもしかしたらあるかもしれません。