Registering multiple APIs for testing

[EdwinRozario]

Hi Team

I was able to test multiple api docs by registering the docs in the before block of each Rspec request test.

RSpec.shared_context "API registration" do
  api_doc = metadata[:api]

  before do
    OpenapiFirst::Test.register(Rails.root.join("docs", "api", "#{api_doc}.yaml"))
  end
end

But this means the context has to be included in every test and metadats set for every test file. Later i found that i could register multiple docs by

OpenapiFirst::Test.register( Rails.root.join("docs/api/v1.yaml"), as: :v1)
OpenapiFirst::Test.register(Rails.root.join("docs/api/v2.yaml"), as: :v2)

and added RSpec.describe "V1 Endpoint", openapi: :v1 do to the test.

But i am getting OpenapiFirst::Test::NotRegisteredError: when doing the above. Was this not designed to do this? Do you have a suggestion to solve this?

[ahx]

Hey @EdwinRozario

Do you want to use the assertion method assert_api_conform ?
If yes, you can use assert_api_conform(status: 200, api: :v1) to tell what API you want to validate against.

[ahx]

The coverage feature that you can initialize via OpenapiFirst::Test.setup(....) currently does not handle multiple API descriptions, but should that should not take too long to add.

[EdwinRozario]

@ahx Thank you for the quick reply.

Yes the project has been using assert_api_conform. Now that we have to separate API docs, multiple registration of docs for tests is something that we need to do. Registering docs in the before hook adds a lot more code and unnecessary switching between registrations when the whole test suite is run.

[ahx]

@EdwinRozario could you solve your problem using assert_api_conform(status: 200, api: :v1) or did that not work as well?

[EdwinRozario]

@EdwinRozario could you solve your problem using assert_api_conform(status: 200, api: :v1) or did that not work as well?

I had to include OpenapiFirst::Test::Methods in the shared context to get assert_api_conform working in the test.

# frozen_string_literal: true

require "openapi_first/test"

RSpec.shared_context "Openapi doc registration" do
  spec_path = metadata[:file_path]

  if spec_path.include? "spec/requests/api/"
    api_doc = if spec_path.include? "api/internal/"
      "internal"
    elsif spec_path.include? "api/external/"
      "external"
    end

    if api_doc
      before do
        OpenapiFirst::Test.register(Rails.root.join("docs", "api", "#{api_doc}.yaml"))
      end
    end

    include OpenapiFirst::Test::Methods
  end
end

spec_helper.rb

RSpec.configure do |config|
  config.include_context "Openapi doc registration"
end

This works fine. But this means OpenapiFirst::Test.register is called before every test.

I am suing 2.1.1

[ahx]

Hi again.

I did some improvements around this in #355.
I got inspired by your cool RSpec metadata trick so that PR adds this as well. I guess I have to document the whole thing a bit better 😴 , but something like this should work now:

# spec_helper.rb
OpenapiFirst::Test.setup do |test|
  test.register('internal.yaml', as: :internal)
  test.register('external.yaml', as: :external)
 #  test.minimum_coverage = 100
end

RSpec.configure do |config|
  config.include OpenapiFirst::Test::Methods[Application], type: :request
end

# some_spec.rb
RSpec.describe 'The internal API', type: :request, api: :internal do 
  it 'works' do
    get '/internal'
    
    assert_api_conform(status: 200)
  end
end

Can you try that from that branch, @EdwinRozario ?

If you pass your Application in config.include OpenapiFirst::Test::Methods[Application] to wrap it with request/response validation and set minimum_coverage = 100 you no longer really need to call assert_api_conform.

[EdwinRozario]

@ahx This change is working for us. Thank you

[ahx]

Solved via #355. Will do a new release this weekend.

[ahx]

Better support for multiple APIs, as outlined here, was just released in 2.7.0.

Thanks for your work on this, @EdwinRozario.