jsonapi-swagger 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2396430a85aede1cfd926f160bde4437a848492306b4faaf2e153287140b5f1
-  data.tar.gz: 9f09eb3b646ab27c3357d93c5b1ad542f8abb507186ac476b9ec17c98df10426
+  metadata.gz: 92c1984cded48de28c42fc2c6cea1942f17a985a485c0620941a55e8a6d8259c
+  data.tar.gz: 5ecc81a8c945a282346a0f20420be0cd047fcf715abea97986cf374285b780d1
 SHA512:
-  metadata.gz: 13d71fa7dcc74a753a8f5ce78078e70031eb95b2bd9f10f71a1ea16c644c86fa8909b2766f65cdc9ff7e91a1432824983e70a5647e2956c3243c034f5b0f9c25
-  data.tar.gz: 8063865a8234b71e50f0593f176c6b3e796f5c4a932022380649739ef677d62336b39a52bf0c90359381ae93b9f493a4ba4d97f66ee54409a1fa0c1f248c6d06
+  metadata.gz: b1918de62437786e214d29396a254693899d34325d3762a20c0327bf8f340b848a36a92ae3815e16b607fbb7b07957e7d2fc7ca3b842b9f991750edcc084f6cc
+  data.tar.gz: 8f93aa0c863bc241859ca952f2d103346552af40882bbfa35d68900561a832e0af3daf4c131c361e0bced923ccf1d35e3347828fe88565bb23663cc3805ebfde

data/README.md

@@ -4,6 +4,8 @@ Generate JSONAPI Swagger Doc.
 
 [![Gem Version](https://img.shields.io/gem/v/jsonapi-swagger.svg)](https://rubygems.org/gems/jsonapi-swagger) [![GitHub license](https://img.shields.io/github/license/superiorlu/jsonapi-swagger.svg)](https://github.com/superiorlu/jsonapi-swagger/blob/master/LICENSE)
 
+[![jsonapi-swagger-4-2-9.gif](https://i.loli.net/2019/05/05/5ccebf5e782b7.gif)](https://i.loli.net/2019/05/05/5ccebf5e782b7.gif)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/generators/jsonapi/swagger/swagger_generator.rb

@@ -34,6 +34,10 @@ module Jsonapi
       (class_path + [file_name]).map!(&:camelize).join("::")
     end
 
+    def sortable_fields_desc
+      t(:sortable_fields) + ': (-)' + sortable_fields.join(',')
+    end
+
     def model_klass
       model_class_name.safe_constantize
     end
@@ -50,6 +54,18 @@ module Jsonapi
       resource_klass._relationships
     end
 
+    def sortable_fields
+      resource_klass.sortable_fields
+    end
+
+    def creatable_fields
+      resource_klass.creatable_fields - relationships.keys
+    end
+
+    def updatable_fields
+      resource_klass.updatable_fields - relationships.keys
+    end
+
     def filters
       resource_klass.filters
     end

data/lib/generators/jsonapi/swagger/templates/swagger.rb.erb

@@ -11,6 +11,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
       tags '<%= route_resouces %>'
       produces 'application/vnd.api+json'
       parameter name: :'page[number]', in: :query, type: :string, description: '<%= t(:page_num) %>', required: false
+<% if sortable_fields.present? -%>
+      parameter name: :'sort', in: :query, type: :string, description: '<%= sortable_fields_desc %>', required: false
+<% end -%>
 <% if relationships.present? -%>
       parameter name: :include, in: :query, type: :string, description: '<%= t(:include_related_data) %>', required: false
 <% end -%>
@@ -165,6 +168,264 @@ RSpec.describe '<%= resouces_name %>', type: :request do
       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

data/lib/i18n/en.yml

@@ -2,6 +2,7 @@ en:
   jsonapi_swagger:
     page_num: 'Page Number'
     include_related_data: 'Include Related Data'
+    sortable_fields: 'Sortable Fields'
     display_field: 'Display Field'
     filter_field: 'Filter Field'
     list: 'List'
@@ -22,4 +23,10 @@ en:
     page_links: 'Page Link'
     detail: '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'

data/lib/i18n/zh-CN.yml

@@ -2,6 +2,7 @@ zh-CN:
   jsonapi_swagger:
     page_num: '页码'
     include_related_data: '包含关联数据'
+    sortable_fields: '排序字段'
     display_field: '显示字段'
     filter_field: '过滤字段'
     list: '列表'
@@ -22,4 +23,10 @@ zh-CN:
     page_links: '分页链接'
     detail: '详情'
     get_dtail: '获取详情'
-    detail_link: '详情链接'
+    detail_link: '详情链接'
+    create: '创建'
+    patch: '更新'
+    delete: '删除'
+    related_id: '相关%{model}ID'
+    related_ids: '相关%{model}IDs'
+    request_body: '请求body'

data/lib/jsonapi/swagger/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Swagger
-    VERSION = '0.4.1'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler