Docker+Rails6+apipie를 사용하여 API 정의를 Swagger UI에 표시

환경

Ruby: 2.7.1
Rails: 6.0.3

1. API 정의가 작성된 파일 자동 생성

소개

gem "apipie-rails"

$ bundle install
$ rails g apipie:install

문서 작성

class Api::V1::UsersController < ApiController

  api :POST, "/api/v1/users/token", "get access token"
  description "ログイン認証をしてトークンを返す"
  formats ["json"]
  param :email, String, desc: "メールアドレス", required: true
  param :password, String, desc: "パスワード", required: true
  returns code: 200, desc: "return user token"
  error code: 401, desc: "Unauthorized"
  example <<-JSON
    {
      detail: "Token Example",
    }
  JSON

  def token
    # 実装略
  end

API 정의 파일 생성

$ rails apipie:static_swagger_json

2. docker-compose에서 Swagger UI의 컨테이너 관리

docker-compose 설정

services:
  app:
   (略)

  swagger-ui:
    image: swaggerapi/swagger-ui
    ports:
      - "8081:8080"
    volumes:
      - doc/apidoc/schema_swagger_form_data.json:/swagger.json
    environment:
      SWAGGER_JSON: /swagger.json

apipie.rb 조정

-  config.api_base_url            = "/api"
+  config.api_base_url            = ""
+  config.swagger_api_host = "localhost:3100"

3. 로컬 환경의 Swagger UI에서 API 정의 탐색 및 요청/응답 수행

CORS 설정

gem "rack-cors"

module App
  class Application < Rails::Application
    (中略）

    # 以下を追加
    config.x.request = ActiveSupport::InheritableOptions.new(config_for(:request))

    # Permit cross origin
    config.middleware.insert_before 0, Rack::Cors do
      allow do
        origins Rails.application.config.x.request["domain"]
        resource "*",
        headers: :any,
        methods: [:get, :post, :put, :patch, :delete, :options, :head]
      end
    end
  end
end

default: &default
  domain:
   - localhost:3100 # appのport
   - localhost:8081 # swagger-uiのport

development:
  <<: *default

test:
  <<: *default

production:
  domain: