Railsで作ったREST APIをSwagger対応背景 Web API Advent Calendar 12月3日分@takurosさんの12月2日のSwaggerとは何か？ を前提としています。 概要 swagger-docs を使ってRailsのREST APIをswaggerで表示出来るようにします。郵便番号検索APIのAPIを表現してみます。 手順 Gemfileにswagger-docsを追加します。 しかしながら、masterブランチにバグがあり、pathにスラッシュが付かないので、forkされたgemを使います。 gemをインストールします。 $ bundle swaggerの初期設定ファイルを作成します。 initializerをconfig/initializers/swagger_docs.rbに作成して、以下のようにAPIサーバの基本情報を書いておきます。 該当するControllerに、API仕様を追記します。 今
