Swagger UI を使ってみる
Swagger
Published: 2019-08-26

やったこと

Swagger UI を使ってみます

調査

Swagger UI を表示する環境を準備

$ docker pull swaggerapi/swagger-ui
$ docker run -p 80:8080 swaggerapi/swagger-ui

http://localhost:8080/ で Swagger UI が利用できるようになります。

Swagger UI から Web API サーバーへアクセスできるようにする

Gemfile

gem 'rack-cors', :group => :development
$ bundle install

config/initializers/cors.rb

Rails.application.config.middleware.insert_before 0, Rack::Cors do
  allow do
    origins '*'
    resource '*', headers: :any, methods: [:get, :post, :options]
  end
end

openapi.yml はこの記事で書いたものを利用します。

※ public ディレクトリに配置しました。

http://localhost:3000/openapi.yml で Exploreすると利用できます。

課題

実運用するときには、外から見えない位置に openapi.yml を配置する必要があると思いました。

参考