swaggable 0.4.0

data/lib/swaggable/version.rb

@@ -0,0 +1,3 @@
+module Swaggable
+  VERSION = '0.4.0'
+end

data/spec/assets/valid-swagger-2.0.json

@@ -0,0 +1 @@
+{"swagger":"2.0","info":{"description":"This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.","version":"1.0.0","title":"Swagger Petstore","termsOfService":"http://swagger.io/terms/","contact":{"email":"apiteam@swagger.io"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"host":"petstore.swagger.io","basePath":"/v2","tags":[{"name":"pet","description":"Everything about your Pets","externalDocs":{"description":"Find out more","url":"http://swagger.io"}},{"name":"store","description":"Access to Petstore orders"},{"name":"user","description":"Operations about user","externalDocs":{"description":"Find out more about our store","url":"http://swagger.io"}}],"schemes":["http"],"paths":{"/pet":{"post":{"tags":["pet"],"summary":"Add a new pet to the store","description":"","operationId":"addPet","consumes":["application/json","application/xml"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"Pet object that needs to be added to the store","required":true,"schema":{"$ref":"#/definitions/Pet"}}],"responses":{"405":{"description":"Invalid input"}},"security":[{"petstore_auth":["write:pets","read:pets"]}]},"put":{"tags":["pet"],"summary":"Update an existing pet","description":"","operationId":"updatePet","consumes":["application/json","application/xml"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"Pet object that needs to be added to the store","required":true,"schema":{"$ref":"#/definitions/Pet"}}],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Pet not found"},"405":{"description":"Validation exception"}},"security":[{"petstore_auth":["write:pets","read:pets"]}]}},"/pet/findByStatus":{"get":{"tags":["pet"],"summary":"Finds Pets by status","description":"Multiple status values can be provided with comma seperated strings","operationId":"findPetsByStatus","produces":["application/xml","application/json"],"parameters":[{"name":"status","in":"query","description":"Status values that need to be considered for filter","required":true,"type":"array","items":{"type":"string","enum":["available","pending","sold"],"default":"available"},"collectionFormat":"csv"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Pet"}}},"400":{"description":"Invalid status value"}},"security":[{"petstore_auth":["write:pets","read:pets"]}]}},"/pet/findByTags":{"get":{"tags":["pet"],"summary":"Finds Pets by tags","description":"Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.","operationId":"findPetsByTags","produces":["application/xml","application/json"],"parameters":[{"name":"tags","in":"query","description":"Tags to filter by","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"csv"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Pet"}}},"400":{"description":"Invalid tag value"}},"security":[{"petstore_auth":["write:pets","read:pets"]}]}},"/pet/{petId}":{"get":{"tags":["pet"],"summary":"Find pet by ID","description":"Returns a single pet","operationId":"getPetById","produces":["application/xml","application/json"],"parameters":[{"name":"petId","in":"path","description":"ID of pet to return","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Pet"}},"400":{"description":"Invalid ID supplied"},"404":{"description":"Pet not found"}},"security":[{"api_key":[]}]},"post":{"tags":["pet"],"summary":"Updates a pet in the store with form data","description":"","operationId":"updatePetWithForm","consumes":["application/x-www-form-urlencoded"],"produces":["application/xml","application/json"],"parameters":[{"name":"petId","in":"path","description":"ID of pet that needs to be updated","required":true,"type":"integer","format":"int64"},{"name":"name","in":"formData","description":"Updated name of the pet","required":false,"type":"string"},{"name":"status","in":"formData","description":"Updated status of the pet","required":false,"type":"string"}],"responses":{"405":{"description":"Invalid input"}},"security":[{"petstore_auth":["write:pets","read:pets"]}]},"delete":{"tags":["pet"],"summary":"Deletes a pet","description":"","operationId":"deletePet","produces":["application/xml","application/json"],"parameters":[{"name":"api_key","in":"header","required":false,"type":"string"},{"name":"petId","in":"path","description":"Pet id to delete","required":true,"type":"integer","format":"int64"}],"responses":{"400":{"description":"Invalid pet value"}},"security":[{"petstore_auth":["write:pets","read:pets"]}]}},"/pet/{petId}/uploadImage":{"post":{"tags":["pet"],"summary":"uploads an image","description":"","operationId":"uploadFile","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"petId","in":"path","description":"ID of pet to update","required":true,"type":"integer","format":"int64"},{"name":"additionalMetadata","in":"formData","description":"Additional data to pass to server","required":false,"type":"string"},{"name":"file","in":"formData","description":"file to upload","required":false,"type":"file"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiResponse"}}},"security":[{"petstore_auth":["write:pets","read:pets"]}]}},"/store/inventory":{"get":{"tags":["store"],"summary":"Returns pet inventories by status","description":"Returns a map of status codes to quantities","operationId":"getInventory","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"security":[{"api_key":[]}]}},"/store/order":{"post":{"tags":["store"],"summary":"Place an order for a pet","description":"","operationId":"placeOrder","produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"order placed for purchasing the pet","required":true,"schema":{"$ref":"#/definitions/Order"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Order"}},"400":{"description":"Invalid Order"}}}},"/store/order/{orderId}":{"get":{"tags":["store"],"summary":"Find purchase order by ID","description":"For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions","operationId":"getOrderById","produces":["application/xml","application/json"],"parameters":[{"name":"orderId","in":"path","description":"ID of pet that needs to be fetched","required":true,"type":"integer","maximum":5.0,"minimum":1.0,"format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Order"}},"400":{"description":"Invalid ID supplied"},"404":{"description":"Order not found"}}},"delete":{"tags":["store"],"summary":"Delete purchase order by ID","description":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors","operationId":"deleteOrder","produces":["application/xml","application/json"],"parameters":[{"name":"orderId","in":"path","description":"ID of the order that needs to be deleted","required":true,"type":"string","minimum":1.0}],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Order not found"}}}},"/user":{"post":{"tags":["user"],"summary":"Create user","description":"This can only be done by the logged in user.","operationId":"createUser","produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"Created user object","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"default":{"description":"successful operation"}}}},"/user/createWithArray":{"post":{"tags":["user"],"summary":"Creates list of users with given input array","description":"","operationId":"createUsersWithArrayInput","produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"List of user object","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/User"}}}],"responses":{"default":{"description":"successful operation"}}}},"/user/createWithList":{"post":{"tags":["user"],"summary":"Creates list of users with given input array","description":"","operationId":"createUsersWithListInput","produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"List of user object","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/User"}}}],"responses":{"default":{"description":"successful operation"}}}},"/user/login":{"get":{"tags":["user"],"summary":"Logs user into the system","description":"","operationId":"loginUser","produces":["application/xml","application/json"],"parameters":[{"name":"username","in":"query","description":"The user name for login","required":true,"type":"string"},{"name":"password","in":"query","description":"The password for login in clear text","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"},"headers":{"X-Rate-Limit":{"type":"integer","format":"int32","description":"calls per hour allowed by the user"},"X-Expires-After":{"type":"string","format":"date-time","description":"date in UTC when toekn expires"}}},"400":{"description":"Invalid username/password supplied"}}}},"/user/logout":{"get":{"tags":["user"],"summary":"Logs out current logged in user session","description":"","operationId":"logoutUser","produces":["application/xml","application/json"],"parameters":[],"responses":{"default":{"description":"successful operation"}}}},"/user/{username}":{"get":{"tags":["user"],"summary":"Get user by user name","description":"","operationId":"getUserByName","produces":["application/xml","application/json"],"parameters":[{"name":"username","in":"path","description":"The name that needs to be fetched. Use user1 for testing. ","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"Invalid username supplied"},"404":{"description":"User not found"}}},"put":{"tags":["user"],"summary":"Updated user","description":"This can only be done by the logged in user.","operationId":"updateUser","produces":["application/xml","application/json"],"parameters":[{"name":"username","in":"path","description":"name that need to be deleted","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated user object","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"400":{"description":"Invalid user supplied"},"404":{"description":"User not found"}}},"delete":{"tags":["user"],"summary":"Delete user","description":"This can only be done by the logged in user.","operationId":"deleteUser","produces":["application/xml","application/json"],"parameters":[{"name":"username","in":"path","description":"The name that needs to be deleted","required":true,"type":"string"}],"responses":{"400":{"description":"Invalid username supplied"},"404":{"description":"User not found"}}}}},"securityDefinitions":{"petstore_auth":{"type":"oauth2","authorizationUrl":"http://petstore.swagger.io/api/oauth/dialog","flow":"implicit","scopes":{"write:pets":"modify pets in your account","read:pets":"read your pets"}},"api_key":{"type":"apiKey","name":"api_key","in":"header"}},"definitions":{"Order":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"petId":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"shipDate":{"type":"string","format":"date-time"},"status":{"type":"string","description":"Order Status","enum":["placed","approved","delivered"]},"complete":{"type":"boolean","default":false}},"xml":{"name":"Order"}},"Category":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Category"}},"User":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"userStatus":{"type":"integer","format":"int32","description":"User Status"}},"xml":{"name":"User"}},"Tag":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"xml":{"name":"Tag"}},"Pet":{"type":"object","required":["name","photoUrls"],"properties":{"id":{"type":"integer","format":"int64"},"category":{"$ref":"#/definitions/Category"},"name":{"type":"string","example":"doggie"},"photoUrls":{"type":"array","xml":{"name":"photoUrl","wrapped":true},"items":{"type":"string"}},"tags":{"type":"array","xml":{"name":"tag","wrapped":true},"items":{"$ref":"#/definitions/Tag"}},"status":{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}},"xml":{"name":"Pet"}},"ApiResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"type":{"type":"string"},"message":{"type":"string"}}}},"externalDocs":{"description":"Find out more about Swagger","url":"http://swagger.io"}}

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rspec'
+require 'pry'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+   config.color = true
+   config.tty = true
+   config.disable_monkey_patching!
+   # config.full_backtrace = true
+   # config.formatter = :documentation # :documentation, :progress, :html, :textmate
+end
+
+$LOAD_PATH.unshift File.expand_path('lib')
+require 'swaggable'
+
+$LOAD_PATH.unshift File.expand_path('spec/support')
+

data/spec/swaggable/api_definition_spec.rb

@@ -0,0 +1,169 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'Swaggable::ApiDefinition' do
+  let(:subject_class) { Swaggable::ApiDefinition }
+  let(:subject_instance) { Swaggable::ApiDefinition.new }
+  subject { subject_instance }
+
+  it 'has a version' do
+    subject.version = 'v2.0'
+    expect(subject.version).to eq  'v2.0'
+  end
+
+  it 'has a title' do
+    subject.title = 'a new title'
+    expect(subject.title).to eq  'a new title'
+  end
+
+  it 'has a description' do
+    subject.description = 'a new description'
+    expect(subject.description).to eq  'a new description'
+  end
+
+  it 'has a base_path' do
+    subject.base_path = 'a new base_path'
+    expect(subject.base_path).to eq  'a new base_path'
+  end
+
+  it 'has endpoints' do
+    endpoint = Swaggable::EndpointDefinition.new verb: :get, path: '/'
+    subject.endpoints << endpoint
+    expect(subject.endpoints.first).to eq endpoint
+  end
+
+  describe '#endpoints' do
+    subject { subject_instance.endpoints }
+
+    it 'accumulates endpoints with <<' do
+      endpoint = Swaggable::EndpointDefinition.new verb: :get, path: '/'
+      subject << endpoint
+      expect(subject['GET /']).to be endpoint
+    end
+
+    it 'accumulates endpoints with add' do
+      endpoint = Swaggable::EndpointDefinition.new verb: :get, path: '/'
+      subject.add endpoint
+      expect(subject['GET /']).to be endpoint
+    end
+
+    it 'adds new endpoints' do
+      endpoint = subject.add_new do |e|
+        e.verb = :post
+        e.path = '/users'
+      end
+
+      expect(subject['POST /users']).to be endpoint
+    end
+
+    it 'iterates through endpoints' do
+      has_run = false
+
+      endpoint = subject.add_new do |e|
+        e.verb = :post
+        e.path = '/users'
+      end
+
+      subject.each do |e|
+        has_run = true
+        expect(e).to be endpoint
+      end
+    end
+
+    it 'converts to array' do
+      endpoint = subject.add_new do |e|
+        e.verb = :post
+        e.path = '/users'
+      end
+
+      expect(subject.to_a).to eq [endpoint]
+    end
+
+    it 'clears' do
+      endpoint = subject.add_new do |e|
+        e.verb = :post
+        e.path = '/users'
+      end
+
+      subject.clear
+
+      expect(subject.to_a).to eq []
+    end
+  end
+
+  describe '#tags' do
+    it 'is collected from endpoints' do
+      tag = instance_double(Swaggable::TagDefinition, name: 'A tag')
+      endpoint = Swaggable::EndpointDefinition.new verb: :get, path: '/'
+      endpoint.tags << tag
+      subject.endpoints << endpoint
+      expect(subject.tags.first).to eq tag
+    end
+
+    it 'avoids duplicates' do
+      tag_1 = Swaggable::TagDefinition.new name: 'tag_1'
+      tag_1_again = Swaggable::TagDefinition.new name: 'tag_1'
+      tag_2 = Swaggable::TagDefinition.new name: 'tag_2'
+
+      endpoint_a = Swaggable::EndpointDefinition.new
+      endpoint_b = Swaggable::EndpointDefinition.new
+
+      endpoint_a.tags << tag_1
+      endpoint_b.tags << tag_1_again
+      endpoint_b.tags << tag_2
+
+      subject.endpoints << endpoint_a
+      subject.endpoints << endpoint_b
+
+      expect(subject.tags.to_a).to eq [tag_1_again, tag_2]
+    end
+
+    it 'is empty array when no tags are present' do
+      subject.endpoints.clear
+      expect(subject.tags).to eq []
+    end
+
+    it 'is frozen to avoid giving the false impression that it can be modified' do
+      expect{ subject.tags << instance_double(Swaggable::TagDefinition) }.to raise_error
+    end
+  end
+
+  it 'yields itself on initialize' do
+    yielded = false
+
+    subject_class.new do |s|
+      expect(s).to be_a subject_class
+      yielded = true
+    end
+
+    expect(yielded).to be true
+  end
+
+  it 'builds from a Grape API' do
+    allow(subject_class.grape_adapter).to receive(:import) { |grape, api| api.title = 'A test'; api }
+    result = subject_class.from_grape_api double('grape')
+    expect(result.title).to eq 'A test'
+  end
+
+  it 'has a dsl' do
+    api = Swaggable::ApiDefinition.new
+
+    api.configure do
+      version 'v1.0'
+      title 'My API'
+      description 'My cool API'
+      base_path '/a/path'
+
+      endpoints do
+        add_new do
+          path '/users'
+          verb :post
+          description 'Creates users'
+          summary 'Allows to create an user'
+        end
+      end
+    end
+
+    expect(api.version).to eq 'v1.0'
+    expect(api.endpoints.first.path).to eq '/users'
+  end
+end

data/spec/swaggable/endpoint_definition_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'Swaggable::EndpointDefinition' do
+  let(:subject_class) { Swaggable::EndpointDefinition }
+  let(:subject_instance) { Swaggable::EndpointDefinition.new }
+  subject { subject_instance }
+
+  it 'has a path' do
+    subject.path = '/'
+    expect(subject.path).to eq  '/'
+  end
+
+  it 'has a verb' do
+    subject.verb = 'POST'
+    expect(subject.verb).to eq  'POST'
+  end
+
+  it 'has a description' do
+    subject.description = 'a new desc'
+    expect(subject.description).to eq  'a new desc'
+  end
+
+  it 'has a summary' do
+    subject.summary = 'a new summary'
+    expect(subject.summary).to eq  'a new summary'
+  end
+
+  it 'has tags' do
+    tag = instance_double(Swaggable::TagDefinition, name: 'A Tag')
+    subject.tags << tag
+    expect(subject.tags.to_a).to eq  [tag]
+  end
+
+  it 'has consumes' do
+    format = double('format')
+    subject.consumes << format
+    expect(subject.consumes).to eq  [format]
+  end
+
+  it 'has produces' do
+    format = double('format')
+    subject.produces << format
+    expect(subject.produces).to eq  [format]
+  end
+
+  it 'has parameters' do
+    parameter = Swaggable::ParameterDefinition.new name: 'some_parameter'
+    subject.parameters << parameter
+    expect(subject.parameters.to_a).to eq  [parameter]
+  end
+
+  it 'yields itself on initialize' do
+    yielded = false
+
+    subject_class.new do |s|
+      expect(s).to be_a subject_class
+      yielded = true
+    end
+
+    expect(yielded).to be true
+  end
+
+  it 'accepts attributes on initialize' do
+    endpoint = subject_class.new path: '/a/path', verb: 'GET'
+    expect(endpoint.path).to eq '/a/path'
+    expect(endpoint.verb).to eq 'GET'
+  end
+
+  it 'has responses' do
+    subject.responses.add_new do
+      status 418
+      description 'Teapot'
+    end
+
+    expect(subject.responses[418].description).to eq 'Teapot'
+  end
+end

data/spec/swaggable/grape_adapter_spec.rb

@@ -0,0 +1,198 @@
+require_relative '../spec_helper'
+require 'grape'
+
+RSpec.describe 'Swaggable::GrapeAdapter' do
+  let(:subject_class) { Swaggable::GrapeAdapter }
+  let(:subject_instance) { Swaggable::GrapeAdapter.new }
+  subject { subject_instance }
+
+  describe '#import(grape_api, api_definition)' do
+    let(:api) { Swaggable::ApiDefinition.new }
+    let(:grape) { Class.new(Grape::API) }
+
+    def do_import
+      subject.import grape, api
+    end
+
+    it 'returns the api' do
+      api = do_import
+      expect(api).to be_a Swaggable::ApiDefinition
+    end
+
+    it 'sets version' do
+      grape.version 'v2.0'
+      do_import
+      expect(api.version).to eq 'v2.0'
+    end
+
+    it 'sets title' do
+      allow(grape).to receive(:name).and_return('MyAPI')
+      do_import
+      expect(api.title).to eq 'MyAPI'
+    end
+
+    it 'sets base path' do
+      do_import
+      expect(api.base_path).to eq '/'
+    end
+
+    describe 'endpoints' do
+      it 'sets verb' do
+        grape.post { }
+        do_import
+        expect(api.endpoints.first.verb).to eq 'post'
+      end
+
+      it 'sets description as summary' do
+        grape.desc 'My endpoint'
+        grape.post { }
+        do_import
+        expect(api.endpoints.first.summary).to eq 'My endpoint'
+      end
+
+      it 'sets format' do
+        grape.format :json
+        grape.post { }
+        do_import
+        expect(api.endpoints.first.produces).to eq ['application/json']
+      end
+
+      describe 'path' do
+        it 'has no (.:format)' do
+          grape.post('/a/path') { }
+          do_import
+          expect(api.endpoints.first.path).to eq '/a/path'
+        end
+
+        it 'has no (/.:format)' do
+          grape.version 'v1.0'
+          grape.get('/') { }
+          do_import
+          expect(api.endpoints.first.path).to eq '/v1.0'
+        end
+
+        it 'has version number' do
+          grape.version 'v3.0'
+          grape.post('/a/path') { }
+          do_import
+          expect(api.endpoints.first.path).to eq '/v3.0/a/path'
+        end
+
+        it 'has version number if present with prefix too' do
+          grape.version 'v3.0'
+          grape.prefix '/api'
+          grape.post('/a/path') { }
+          do_import
+          expect(api.endpoints.first.path).to eq '/api/v3.0/a/path'
+        end
+
+        it 'has version number if present with prefix not beginning with / too' do
+          grape.version 'v3.0'
+          grape.prefix 'api'
+          grape.post('/a/path') { }
+          do_import
+          expect(api.endpoints.first.path).to eq '/api/v3.0/a/path'
+        end
+
+        it 'has parameters' do
+          grape.version 'v3.0'
+          grape.prefix '/api'
+          grape.post('/a/path/:with/:parameters') { }
+          do_import
+          expect(api.endpoints.first.path).to eq '/api/v3.0/a/path/{with}/{parameters}'
+        end
+
+        it 'has tags' do
+          grape.post('/a/path') { }
+          do_import
+          tag = api.endpoints.first.tags.first
+          expect(tag.name).to eq grape.name
+        end
+      end
+
+      describe 'parameters' do
+        it 'have name' do
+          grape.params do
+            requires :user_uuid
+          end
+
+          grape.post('/a/path') { }
+
+          do_import
+          expect(api.endpoints.first.parameters.first.name).to eq 'user_uuid'
+        end
+
+        it 'have type' do
+          grape.params do
+            requires :user_uuid, type: String
+          end
+
+          grape.post('/a/path') { }
+
+          do_import
+          expect(api.endpoints.first.parameters.first.type).to eq :string
+        end
+
+        it 'have required' do
+          grape.params do
+            requires :required_param
+          end
+
+          grape.post('/a/path') { }
+
+          do_import
+          expect(api.endpoints.first.parameters.first.required).to eq true
+        end
+
+        it 'have description' do
+          grape.params do
+            requires :param, desc: 'A param'
+          end
+
+          grape.post('/a/path') { }
+
+          do_import
+          expect(api.endpoints.first.parameters.first.description).to eq 'A param'
+        end
+
+        it 'have location path if path param' do
+          grape.params do
+            requires :required_param
+          end
+
+          grape.post('/a/:required_param') { }
+
+          do_import
+          expect(api.endpoints.first.parameters.first.location).to eq :path
+        end
+
+        it 'have location query if non-path param' do
+          grape.params do
+            requires :required_param
+          end
+
+          grape.post('/a') { }
+
+          do_import
+          expect(api.endpoints.first.parameters.first.location).to eq :query
+        end
+      end
+
+      describe 'responses' do
+        it 'have status' do
+          grape.post('/', http_codes: [201, 'Created']) { }
+
+          do_import
+          expect(api.endpoints.first.responses.first.status).to eq 201
+        end
+
+        it 'have description' do
+          grape.post('/', http_codes: [[201, 'Created']]) { }
+
+          do_import
+          expect(api.endpoints.first.responses.first.description).to eq 'Created'
+        end
+      end
+    end
+  end
+end