0

実装した検索エンドポイントのテストとドキュメント作成に取り組んでいます。クエリ パラメータを適切に追加するのに問題があります。基本的に、リクエスト URL は次のようになります。

"/api/v3/workspaces/1/searches?filter[query]=b&filter[type]=ct:Tag,User,WorkingArea"

私のコントローラは次のようになります

class SearchesController < ApiV3Controller
    load_and_authorize_resource :workspace
    load_and_authorize_resource :user, through: :workspace
    load_and_authorize_resource :working_area, through: :workspace
    load_and_authorize_resource :tag, through: :workspace

    def index
      @resources = relevant_search_results

      render_json(@resources)
    end

    private

    def ability_klasses
      [WorkspaceAbility, UserWorkspaceAbility, WorkingAreaAbility, TagAbility]
    end

    def relevant_search_results
      query = filtered_params[:query]
      types = filtered_params[:type]
      items = params[:items]
      GlobalSearcher.new(query, types, items, @workspace).relevant_search_results
    end

    def render_json(resources)
      render json: resources, status: :ok
    end

    def filtered_params
      params.require(:filter).permit(:query, :type)
    end
  end

機能は正常に動作します。問題はテストにあります。spec ファイルは次のようになります。

resource "Searches", :include_basic_variables, type: :api do

parameter :filter
parameter :type
parameter :items
let(:query) { "be" }
let(:type) { "ct:Tag,User,WorkingArea" }
let(:items) { "3" }
let_it_be(:workspace_id) { company.id }
explanation "Searches resource"
 route "/api/v3/workspaces/:workspace_id/searches", "Index" do
with_options with_example: true, required: true do
  parameter :workspace_id, "Workspace ID", type: :integer, example: 1
end


get "List all the relevant items" do
  context "Authenticated" do
    before { sign_in(admin) }

    example 'Search results' do
      do_request

      expect(query_string).to eq("filter[query]=b&filter[type]=ct:Tag,User,WorkingArea&items=3")
      expect(status).to eq 200
    end
  end
end

rspec の実行時に表示されるエラーは次のとおりです。

expected: "filter[query]=b&filter[type]=ct:Tag,User,WorkingArea&items=3"
got: "query=be&type=ct%3ATag%2CUser%2CWorkingArea&items=3
4

1 に答える 1