mirror of
https://github.com/ditkrg/jsonapi-swagger.git
synced 2026-01-22 22:06:50 +00:00
support create update and delete resource
This commit is contained in:
YingRui Lu
parent
4ca14d7cdf
commit
af6f6208ee
@ -58,6 +58,14 @@ module Jsonapi
|
|||||||
resource_klass.sortable_fields
|
resource_klass.sortable_fields
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def creatable_fields
|
||||||
|
resource_klass.creatable_fields - relationships.keys
|
||||||
|
end
|
||||||
|
|
||||||
|
def updatable_fields
|
||||||
|
resource_klass.updatable_fields - relationships.keys
|
||||||
|
end
|
||||||
|
|
||||||
def filters
|
def filters
|
||||||
resource_klass.filters
|
resource_klass.filters
|
||||||
end
|
end
|
||||||
|
|||||||
@ -168,6 +168,264 @@ RSpec.describe '<%= resouces_name %>', type: :request do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
<% unless resource_klass.immutable -%>
|
|
||||||
|
<% if resource_klass.mutable? -%>
|
||||||
|
path '/<%= route_resouces %>' do
|
||||||
|
post '<%= route_resouces %> <%= t(:create) %>' do
|
||||||
|
tags '<%= route_resouces %>'
|
||||||
|
consumes 'application/vnd.api+json'
|
||||||
|
produces 'application/vnd.api+json'
|
||||||
|
parameter name: :data,
|
||||||
|
in: :body,
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
data: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
type: { type: :string, default: '<%= route_resouces %>' },
|
||||||
|
attributes: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% creatable_fields.each do |field| -%>
|
||||||
|
<%= field %>: { type: :<%= columns_with_comment[field][:type] %>, <%if columns_with_comment[field][:is_array] -%> items: { type: :<%= columns_with_comment[field][:items_type] %>},<% end -%>'x-nullable': <%= columns_with_comment[field][:nullable] %>, description: '<%= columns_with_comment[field][:comment] %>'},
|
||||||
|
<% end -%>
|
||||||
|
}
|
||||||
|
},
|
||||||
|
<% if relationships.present? -%>
|
||||||
|
relationships: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% relationships.each do |relation_name, relation| -%>
|
||||||
|
<% relation_name_camelize = relation_name.to_s.camelize -%>
|
||||||
|
<%= relation_name %>: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% if relation.belongs_to? -%>
|
||||||
|
data: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
type: { type: :string, default: '<%= relation.table_name %>' },
|
||||||
|
id: { type: :string, description: '<%= relation_name_camelize %> ID' },
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_id, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% else -%>
|
||||||
|
data: {
|
||||||
|
type: :array,
|
||||||
|
items: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
type: { type: :string, default: '<%= relation.table_name %>' },
|
||||||
|
id: { type: :string, description: '<%= relation_name_camelize %> ID' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_ids, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% end -%>
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_ids, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% end -%>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
<% end -%>
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: '<%= t(:request_body) %>'
|
||||||
|
|
||||||
|
response '201', '<%= t(:create) %>' do
|
||||||
|
schema type: :object,
|
||||||
|
properties: {
|
||||||
|
data: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
id: { type: :string, description: 'ID'},
|
||||||
|
type: { type: :string, description: 'Type'},
|
||||||
|
links: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
self: { type: :string, description: '<%= t(:detail_link) %>'},
|
||||||
|
},
|
||||||
|
description: '<%= t(:detail_link) %>'
|
||||||
|
},
|
||||||
|
attributes: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% attributes.each_key.each do |attr| -%>
|
||||||
|
<%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, <%if columns_with_comment[attr][:is_array] -%> items: { type: :<%= columns_with_comment[attr][:items_type] %>},<% end -%>'x-nullable': <%= columns_with_comment[attr][:nullable] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
|
||||||
|
<% end -%>
|
||||||
|
},
|
||||||
|
description: '<%= t(:attributes) %>'
|
||||||
|
},
|
||||||
|
relationships: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% relationships.each do |relation_name, relation| -%>
|
||||||
|
<% relation_name_camelize = relation_name.to_s.camelize -%>
|
||||||
|
<%= relation_name %>: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
links: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
self: { type: :string, description: '<%= t(:associate_list_link, model: relation_name_camelize) %>' },
|
||||||
|
related: { type: :string, description: '<%= t(:related_link, model: relation_name_camelize )%>' },
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_link, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_link, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% end -%>
|
||||||
|
},
|
||||||
|
description: '<%= t(:associate_data) %>'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
description: '<%= t(:data) %>'
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: [:data]
|
||||||
|
run_test!
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
path '/<%= route_resouces %>/{id}' do
|
||||||
|
patch '<%= route_resouces %> <%= t(:patch) %>' do
|
||||||
|
tags '<%= route_resouces %>'
|
||||||
|
consumes 'application/vnd.api+json'
|
||||||
|
produces 'application/vnd.api+json'
|
||||||
|
parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
|
||||||
|
parameter name: :data,
|
||||||
|
in: :body,
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
data: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
type: { type: :string, default: '<%= route_resouces %>' },
|
||||||
|
id: { type: :string },
|
||||||
|
attributes: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% creatable_fields.each do |field| -%>
|
||||||
|
<%= field %>: { type: :<%= columns_with_comment[field][:type] %>, <%if columns_with_comment[field][:is_array] -%> items: { type: :<%= columns_with_comment[field][:items_type] %>},<% end -%>'x-nullable': <%= columns_with_comment[field][:nullable] %>, description: '<%= columns_with_comment[field][:comment] %>'},
|
||||||
|
<% end -%>
|
||||||
|
}
|
||||||
|
},
|
||||||
|
<% if relationships.present? -%>
|
||||||
|
relationships: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% relationships.each do |relation_name, relation| -%>
|
||||||
|
<% relation_name_camelize = relation_name.to_s.camelize -%>
|
||||||
|
<%= relation_name %>: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% if relation.belongs_to? -%>
|
||||||
|
data: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
type: { type: :string, default: '<%= relation.table_name %>' },
|
||||||
|
id: { type: :string, description: '<%= relation_name_camelize %> ID' },
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_id, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% else -%>
|
||||||
|
data: {
|
||||||
|
type: :array,
|
||||||
|
items: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
type: { type: :string, default: '<%= relation.table_name %>' },
|
||||||
|
id: { type: :string, description: '<%= relation_name_camelize %> ID' },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_ids, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% end -%>
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_ids, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% end -%>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
<% end -%>
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: '<%= t(:request_body) %>'
|
||||||
|
|
||||||
|
response '200', '<%= t(:patch) %>' do
|
||||||
|
schema type: :object,
|
||||||
|
properties: {
|
||||||
|
data: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
id: { type: :string, description: 'ID'},
|
||||||
|
type: { type: :string, description: 'Type'},
|
||||||
|
links: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
self: { type: :string, description: '<%= t(:detail_link) %>'},
|
||||||
|
},
|
||||||
|
description: '<%= t(:detail_link) %>'
|
||||||
|
},
|
||||||
|
attributes: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% attributes.each_key.each do |attr| -%>
|
||||||
|
<%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, <%if columns_with_comment[attr][:is_array] -%> items: { type: :<%= columns_with_comment[attr][:items_type] %>},<% end -%>'x-nullable': <%= columns_with_comment[attr][:nullable] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
|
||||||
|
<% end -%>
|
||||||
|
},
|
||||||
|
description: '<%= t(:attributes) %>'
|
||||||
|
},
|
||||||
|
relationships: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
<% relationships.each do |relation_name, relation| -%>
|
||||||
|
<% relation_name_camelize = relation_name.to_s.camelize -%>
|
||||||
|
<%= relation_name %>: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
links: {
|
||||||
|
type: :object,
|
||||||
|
properties: {
|
||||||
|
self: { type: :string, description: '<%= t(:associate_list_link, model: relation_name_camelize) %>' },
|
||||||
|
related: { type: :string, description: '<%= t(:related_link, model: relation_name_camelize )%>' },
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_link, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
},
|
||||||
|
description: '<%= t(:related_link, model: relation_name_camelize) %>'
|
||||||
|
},
|
||||||
|
<% end -%>
|
||||||
|
},
|
||||||
|
description: '<%= t(:associate_data) %>'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
description: '<%= t(:data) %>'
|
||||||
|
},
|
||||||
|
},
|
||||||
|
required: [:data]
|
||||||
|
let(:id) { @<%= model_name %>.id }
|
||||||
|
run_test!
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
path '/<%= route_resouces %>/{id}' do
|
||||||
|
delete '<%= route_resouces %> <%= t(:delete) %>' do
|
||||||
|
tags '<%= route_resouces %>'
|
||||||
|
produces 'application/vnd.api+json'
|
||||||
|
parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
|
||||||
|
|
||||||
|
response '204', '<%= t(:delete) %>' do
|
||||||
|
let(:id) { @<%= model_name %>.id }
|
||||||
|
run_test!
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
<% end -%>
|
<% end -%>
|
||||||
end
|
end
|
||||||
|
|||||||
@ -23,4 +23,10 @@ en:
|
|||||||
page_links: 'Page Link'
|
page_links: 'Page Link'
|
||||||
detail: 'Detail'
|
detail: 'Detail'
|
||||||
get_dtail: 'Fetch Detail'
|
get_dtail: 'Fetch Detail'
|
||||||
detail_link: 'Detail Link'
|
detail_link: 'Detail Link'
|
||||||
|
create: 'Create'
|
||||||
|
patch: 'Patch'
|
||||||
|
delete: 'Delete'
|
||||||
|
related_id: 'Related %{model} ID'
|
||||||
|
related_ids: 'Related %{model} IDs'
|
||||||
|
request_body: 'Request Body'
|
||||||
@ -23,4 +23,10 @@ zh-CN:
|
|||||||
page_links: '分页链接'
|
page_links: '分页链接'
|
||||||
detail: '详情'
|
detail: '详情'
|
||||||
get_dtail: '获取详情'
|
get_dtail: '获取详情'
|
||||||
detail_link: '详情链接'
|
detail_link: '详情链接'
|
||||||
|
create: '创建'
|
||||||
|
patch: '更新'
|
||||||
|
delete: '删除'
|
||||||
|
related_id: '相关%{model}ID'
|
||||||
|
related_ids: '相关%{model}IDs'
|
||||||
|
request_body: '请求body'
|
||||||
Loading…
Reference in New Issue
Block a user