Swaggerについて


はじめに

未来電子テクノロジーでインターンをしている<小栗>です。
「プログラミング初心者であるため、内容に誤りがあるかもしれません。
もし、誤りがあれば修正するのでどんどん指摘してください。

Swaggerとは

RESTful APIを構築するためのオープンソースフレームワークのこと。
Swagger Spec を書いておけば自動的にドキュメント生成までしてくれ、ドキュメントから実際のリクエストができる。

Swagger Specとは

Swaggerの書式で記述した仕様書のこと。
JSONもしくはYAML形式で記述し、Excelなどでの管理と比較するとテキストベースなのでバージョン管理が容易。

RESTとは

REST(レスト)とはWebサービスの設計モデルのこと。
設計モデルとはDjangoのMTV(Model・Template・View)のように、システムに共通する性質や作法を表す。
また、
・同じURLからは常に同じ内容のレスポンスが返ってくる。
・クライアントのマシンの状態やブラウザのセッションに依存しない。

上記の条件を満たす物をRESTfulなサービスと呼ぶ。