Setup

    # Gemfile
    gem 'rspec-swag'


    # config.ru
    map '/orders' do 
    run Web::OrdersApp 
    end

    map '/admin/orders' do 
    run Web::AdminOrdersApp 
    end

    # rspec 
    describe OrdersApp, :vcr, type: :request do
      let(:described_class) { OrdersApp }

      path '/index' do
        get '' do
        ....
        end
      end 
    end

Problem

rspec-swag generates docs for /index, map is ignored.
So, it isn't possible to test API via Swagger web UI. I need /orders/index in docs.

How to change code in order to make Swagger docs usable?

Setup

    # Gemfile
    gem 'rspec-swag'


    # config.ru
    map '/orders' do 
    run Web::OrdersApp 
    end

    map '/admin/orders' do 
    run Web::AdminOrdersApp 
    end

    # rspec 
    describe OrdersApp, :vcr, type: :request do
      let(:described_class) { OrdersApp }

      path '/index' do
        get '' do
        ....
        end
      end 
    end

Problem

rspec-swag generates docs for /index, map is ignored.
So, it isn't possible to test API via Swagger web UI. I need /orders/index in docs.

How to change code in order to make Swagger docs usable?

• ruby
• sinatra
• rack
• rswag

• 1 Why would you not use path '/orders'? path is a just a helper the same as using describe '/index' there is no magic here so if you want /orders/index you need to tell it that e.g. path '/orders/index' – engineersmnky Commented Mar 13 at 13:11
• Because I have a valid specs for swagger docs generation. And specs are failing if path is not match – gayavat Commented Mar 13 at 14:05
• I wrote rswag rspec tests. Test is failed if path is /orders/index. I want to have successful test and valid docs =) – gayavat Commented Mar 13 at 23:22
• I am not sure how rspec-swag generates the documentation but have you tried wrapping it in context '/orders'. E.g context '/orders' do; path '/index' do...? – engineersmnky Commented Mar 14 at 0:41

1 Answer 1

Solution: use method.

It found here Architecture for a modular, component-based Sinatra Application

# config.ru
run App

# app.ru
class App < Sinatra::Base
  use OrdersApp
  use AdminOrdersApp
end

class OrdersApp < Sinatra::Base
  get '/orders'
end

class AdminOrdersApp < Admin::Base
  get '/admin/orders'
end