mirror of
https://github.com/ditkrg/rswag.git
synced 2026-01-22 22:06:43 +00:00
This will allow to describe multipart in a short way, like JSON payload:
Before:
put 'Creates a blog with thumbnail' do
consumes 'multipart/form-data'
parameter name: :title, in: :formData, type: :string, required: true
parameter name: :content, in: :formData, type: :string, required: true
parameter name: :file, in: :formData, type: :file, required: true
let(:blog) { FactoryBot.build(:blog) }
let(:title) { blog.title }
let(:content) { blog.content }
let(:file) { blog.file }
...
end
After:
put 'Creates a blog with thumbnail' do
consumes 'multipart/form-data'
parameter name: :blog, in: :formData, schema: { '$ref' => '#/definitions/blog' }
let(:blog) { FactoryBot.attributes_for(:blog) }
...
end
Your mileage may vary but you can always choose the best option.
16 lines
535 B
Ruby
16 lines
535 B
Ruby
TestApp::Application.routes.draw do
|
|
|
|
post '/blogs/multipart', to: 'blogs#multipart_create'
|
|
post '/blogs/flexible', to: 'blogs#flexible_create'
|
|
post '/blogs/alternate', to: 'blogs#alternate_create'
|
|
resources :blogs
|
|
put '/blogs/:id/upload', to: 'blogs#upload'
|
|
|
|
post 'auth-tests/basic', to: 'auth_tests#basic'
|
|
post 'auth-tests/api-key', to: 'auth_tests#api_key'
|
|
post 'auth-tests/basic-and-api-key', to: 'auth_tests#basic_and_api_key'
|
|
|
|
mount Rswag::Api::Engine => 'api-docs'
|
|
mount Rswag::Ui::Engine => 'api-docs'
|
|
end
|