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

Question

我在使用 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\"}"

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'

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

Answer 2

返回到以前版本的解决方案有效，但我想继续使用

openapi: '3.0.1'

，我找到了解决方案。

无需将所有内容更改为

json

，我只需添加此部分：

"v1/swagger.yaml" => {
 openapi: "3.0.1",
 ...,
 components: {
  securitySchemes: {
   Bearer: {
    type: :apiKey,
    name: 'Authorization',
    in: :header,
    description: 'Your Bearer token'
   }
  }
 }
}

我们将属性

security [Bearer: {}]

保留在 rspec 文件中：

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

这将显示“授权”按钮：

然后会出现一个模式，您可以在其中加载所需的令牌，仅此而已。