如何使用 Rswag UI 设置承载令牌参数以测试 Rails API

Question

我在使用 Rswag UI gem 测试我的 API 时遇到问题。在参数字段中输入令牌后，授权 headers 似乎未在 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

这是我正在努力解决的问题：parameter name: :Authorization, in: :header, type: :string 我尝试了不同的类型，例如 http、string 和 apiKey，但我还没有运气好

Swager UI 应该 return 的 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\"}"

Answer 1

我根据收到的评论找到了解决方案。我没有看到 swagger UI 中的 Authorize 按钮。所以我基本上在 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 Docs' 到 c.swagger_endpoint '/api-docs/v1/swagger.json', 'API V1 Docs'

最后，我重新启动了服务器，我能够看到上面提到的输入令牌的按钮。

如何使用 Rswag UI 设置承载令牌参数以测试 Rails API

How to set a bearer token param for testing a Rails API using Rswag UI

ruby-on-rails

ruby

rspec

swagger-ui

rswag