Techioz Blog

Rswag UI を使用して Rails API をテストするためのベアラー トークン パラメータを設定する方法

概要

Rswag UI gem を使用して API をテストするときに問題が発生します。 param フィールドにトークンを入力した後、UI で認証ヘッダーが適切に設定されていないようです。それにもかかわらず、テスト自体は合格しており、ターミナルでテストを実行するとエンドポイントにヒットします。詳細については、以下に添付された画像をご覧ください。

application_controller の認証メソッドは次のようになります。

def authenticate!
    authenticate_or_request_with_http_token do |token, _|
      @auth = ApiKey.exists?(access_token: token)
    end
end

swagger_helper セキュリティ定義は次のようになります

  securityDefinitions: {
    Bearer: {
      description: '...',
      type: :apiKey,
      name: 'Authorization',
      in: :header
    }
  }

合格したテストは次のようになります。

require 'swagger_helper'

RSpec.describe 'Api::V1::Events', type: :request do

  let(:access_token) { FactoryBot.create(:api_key).access_token }
  let(:Authorization) { "Bearer #{access_token}" }

  path '/v1/events' do
    post 'Creates an event' do
      tags 'Events'
      consumes 'application/json'
      security [Bearer: {}]
      parameter name: :Authorization, in: :header, type: :string
      parameter name: :event, in: :body, schema: {
          type: :object,
          properties: {
              name: { type: :string },
              description: { type: :string },
              date: { type: :string },
              time: { type: :string }
          },
          required: [ 'name', 'description', 'date', 'time' ]
      }

      response '201', 'created' do
        let(:event) { { name: 'foo', description: 'bar', date: '2020-09-24', time: '00:00:00' } }
        run_test!
      end
    end
   end
 end

これは私が苦労している行です: パラメータ名: :Authorization、in: :header、type: :string http、string、apiKey などのさまざまなタイプを試しましたが、運がありませんでした

Swagger UI が返す Curl は次のようになります。

curl -X POST "http://localhost:3000/v1/events" -H "accept: */*" -H 'Authorization: Bearer ab4d77e61a5ccdc402sb75867328ea77' -H "Content-Type: application/json" -d "{\"name\":\"string\",\"description\":\"string\",\"date\":\"string\",\"time\":\"string\"}"

解決策

いただいたコメントをもとに解決策を見つけました。 Swagger UI に [承認] ボタンが表示されませんでした。したがって、基本的に他のファイルの中で swagger_helper 内でいくつかの更新を行いました

これを変更しました:

  'v1/swagger.yaml' => {
      openapi: '3.0.1',
   ...

これに

  'v1/swagger.json' => {
      swagger: '2.0',
      ....
   }

また、ファイルの下部で config.swagger_format = :yaml を config.swagger_format = :json に変更しました。

次に、コマンド rswag:specs:swaggerize を実行して、json ファイルを生成しました。

イニシャライザも更新しました c.swagger_endpoint ‘/api-docs/v1/swagger.yaml’、‘API V1 ドキュメント’ から c.swagger_endpoint ‘/api-docs/v1/swagger.json’、‘API V1 ドキュメント’

最後に、サーバーを再起動すると、トークンを入力するための上記のボタンが表示されました。