如何设置不记名令牌参数以使用 Rswag UI 测试 Rails API答案

【问题标题】：How to set a bearer token param for testing a Rails API using Rswag UI如何设置不记名令牌参数以使用 Rswag UI 测试 Rails API
【发布时间】：2020-09-25 13:19:04
【问题描述】：

我在使用 Rswag UI gem 测试我的 API 时遇到问题。在参数字段中输入令牌后，似乎未在 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 应该返回的 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\"}"

【问题讨论】：

授权标头应由security [Bearer: {}] 行处理。不需要参数parameter name: :Authorization, ...。相反，单击 Swagger UI 顶部的“授权”按钮，在此处输入“Bearer ”，然后测试请求。这行得通吗？
你说的那个按钮好像是不能点击的，请问有什么配置需要添加到我的helper中来启用这个按钮吗？

标签： ruby-on-rails ruby rspec swagger-ui rswag

【解决方案1】：

我根据收到的评论找到了解决方案。我没有在招摇 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'

最后我重启了服务器，就可以看到上面提到的输入token的按钮了。

【讨论】：