jsonapi-swagger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea93978c9a08288cd98899e5d3503a270be4093954bb073689f0c026771dc7ad
-  data.tar.gz: 0a1d89cb33b692d5fd460b03d5a7983f9b24bbdf92a6563c1cd165eb2d47e825
+  metadata.gz: 8cfab1114fff50d85a5e1a794431587a8f6275e2dbcd2343b4ae4a527ae379e1
+  data.tar.gz: 535abfa4b0960bcaa7f752d30d64f7ba255306bd5652cb522088137754146f65
 SHA512:
-  metadata.gz: ebe4803bee8ad8f5f0b52797c9ebdad9f6a425d3b308c58cbcc119fe43da9d4ff1732e9e4c195db34f0c3eb9df83ee1d9349650132ecfe079bcd3cd4305283ad
-  data.tar.gz: d845a4f4e6147dbe2c74e89802177834a67f9f1dd9d06e4c827659b639de98277a6d5757ad95b27ac43712bb89f64ea6c3c13b0a9bca29746fa20122ff0a45a1
+  metadata.gz: f1846b3909f1fe9948e5e213818df33f763c9c75be9d055ba96149d6bb1f346a4cc1566b5e5b5270d9bb6a1934c03f4411470d48ecf662f5314b8306b77666af
+  data.tar.gz: 204262395c367fab8a0eb6febed30c4420a7bc8191aa872977c087418bd4b0c3bed08739325681a275fa2ddf664eedfa4f51f3520035b0ab53bfc26a82f67181

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

@@ -18,12 +18,16 @@ module Jsonapi
       "#{file_name.downcase.pluralize}_spec.rb"
     end
 
+    def model_name
+      file_name.downcase.singularize
+    end
+
     def resouces_name
       model_class_name.pluralize
     end
 
     def route_resouces
-      resouces_name.downcase.gsub('::', '/')
+      resouces_name.tableize
     end
 
     def model_class_name
@@ -49,14 +53,16 @@ module Jsonapi
     def columns_with_comment
       @columns_with_comment ||= {}.tap do |clos|
         model_klass.columns.each do |col|
-          clos[col.name.to_sym] = { type: swagger_type(col.type), comment: safe_encode(col.comment) }
+          clos[col.name.to_sym] = { type: swagger_type(col), items_type: col.type, is_array: col.array,  nullable: col.null, comment: safe_encode(col.comment) }
         end
       end
     end
 
-    def swagger_type(type)
-      case type
+    def swagger_type(column)
+      return 'array' if column.array
+      case column.type
       when :bigint, :integer then 'integer'
+      when :boolean          then 'boolean'
       else 'string'
       end
     end

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

@@ -1,14 +1,20 @@
 require 'swagger_helper'
 RSpec.describe '<%= resouces_name %>', type: :request do
-<% if resource_klass.immutable -%>
+  let(:include) {''} #see https://github.com/domaindrivendev/rswag/issues/188
+
+  before(:each) do
+    @<%= model_name %> = create :<%= model_name %>
+  end
+
   path '/<%= route_resouces %>' do
     get '<%= route_resouces %>' do
       tags '<%= route_resouces %>'
       produces 'application/vnd.api+json'
       parameter name: :'page[number]', in: :query, type: :string, description: '页码', required: false
       parameter name: :include, in: :query, type: :string, description: '包含关联数据', required: false
-<% relationships.keys.each do |relation| -%>
-      parameter name: :'fields[<%= relation %>]', in: :query, type: :string, description: '包含字段', required: false
+      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '包含字段', required: false
+<% relationships.each_key do |relation| -%>
+      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '包含字段', required: false
 <% end -%>
       response '200', '获取列表' do
         schema type: :object,
@@ -18,7 +24,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
               items: {
                 type: :object,
                 properties: {
-                  id: { type: :integer, description: 'ID'},
+                  id: { type: :string, description: 'ID'},
                   links: {
                     type: :object,
                     properties: {
@@ -29,8 +35,8 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                   attributes: {
                     type: :object,
                     properties: {
-<% attributes.keys.each do |attr| -%>
-                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
+<% 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: '属性'
@@ -70,7 +76,14 @@ RSpec.describe '<%= resouces_name %>', type: :request do
               },
               description: '分页记录数'
             },
-            links: { type: :array, items: { type: :string }, description: '分页链接' },
+            links: {
+              type: :object,
+              properties: {
+                first: { type: :string, description: '第一页'},
+                next: { type: :string, description: '下一页'},
+                last: { type: :string, description: '最后一页'},
+              },
+              description: '分页链接' },
           },
           required: [:data]
         run_test!
@@ -83,16 +96,19 @@ RSpec.describe '<%= resouces_name %>', type: :request do
       tags '<%= route_resouces %>'
       produces 'application/vnd.api+json'
       parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
-
+      parameter name: :include, in: :query, type: :string, description: '包含关联数据', required: false
+      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '包含字段', required: false
+<% relationships.each_key do |relation| -%>
+      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '包含字段', required: false
+<% end -%>
       response '200', '获取详情' do
         schema type: :object,
           properties: {
             data: {
-              type: :array,
-              items: {
                 type: :object,
                 properties: {
-                  id: { type: :integer, description: 'ID'},
+                  id: { type: :string, description: 'ID'},
+                  type: { type: :string, description: 'Type'},
                   links: {
                     type: :object,
                     properties: {
@@ -103,8 +119,8 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                   attributes: {
                     type: :object,
                     properties: {
-<% attributes.keys.each do |attr| -%>
-                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
+<% 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: '属性'
@@ -129,22 +145,19 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                         description: '相关<%= relation_name_camelize %>'
                       },
 <% end -%>
-
-
-
                     },
                     description: '关联数据'
                   }
-              },
             },
             description: '数据'
             },
           },
           required: [:data]
+        let(:id) { @<%= model_name %>.id }
         run_test!
       end
     end
   end
-<% else -%>
+<% unless resource_klass.immutable -%>
 <% end -%>
 end

data/lib/jsonapi/swagger/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Swagger
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler