Swagger Editor で Web APIドキュメントを参照 vol.2

※2017/02/16 時点※

こんにちは、あじゅ~くです。

求めている人が多いのか、
Swagger Editor」が
人気コンテンツになってます。

というわけで!
前回の記事から半年ほど空いていますので、
おさらいとして、第二弾いってみます!

インストール方法は変わっていないので、
過去記事参照をお願いします。

[こちら]
vol.1

で、
インストール出来たら、
このページに戻ってくるとよさげです。

どうつかうのよ…?

ってことで、

まず、
プロジェクトを作らなければ話にならないので、
・「プロジェクト作成」
・「エディタ起動」
します。

おさらいになりますが、
念のため書いときます。

プロジェクト作成

コマンドプロンプトorパワーシェルで
※あっWindows10ですよ
「C:\Work\nodejs-server-server」
↑このフォルダに移動します。

で、ドンッ!

今回のプロジェクト名は、
「azjukeapi」
とします。

$swagger project create azjukeapi

project_create

これだけです。
「C:\Work\nodejs-server-server」以下に
「azjukeapi」フォルダが作成されていると思います。

エディタ起動

ディレクトリそのままで、
こんどは「edit」に変更して、

ドンッ!

$swagger project edit azjukeapi

project_edit

すると、こんな感じで、
launch_editor
エディタが立ち上がりましたね?

デフォルトで作成されるブツは、
GET 「/Hello」API
やはり、プログラムの基本はハローワールド。

で、ここからが本番。
実際にAPIを設計していくわけなんですが、
このブラウザ上で出来てしまいます!

基本的に、
スプリットされた左側がエディタです。

右側はプレビューって感じでしょうか。

お次は、
サーバを起動させます。


$swagger project start azjukeapi

launch_server

これで起動してるはずです。

それでは、
プレビュー画面(右画面)

request_param

↑ここに適当に文字を入れて、
「リクエストボタン」を押してみましょう。

request_button

はいっ。

request_success

サクセス」頂きました!

???

ボディが空?

ハロー「入力文字」

とかでるんでないの?フツーw

で、
「Pretty」タブを選択してみると…

select_pretty

でました。

“Hello, AZJUKE”

ちなみに、
これは「Hello」API用に作られたレスポンスコードなので、
自作のレスポンスを作成する場合は
別途記述する必要があります。

まぁあたりまえですけどね、
自動で思ってるレスポンスが返ってきたら怖いよねw

これで大体使い方は
分かった?かと思います。

次回、新規API作ってみます。

vol.3に続く…

それでは。