jsonapi-swagger 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cfab1114fff50d85a5e1a794431587a8f6275e2dbcd2343b4ae4a527ae379e1
-  data.tar.gz: 535abfa4b0960bcaa7f752d30d64f7ba255306bd5652cb522088137754146f65
+  metadata.gz: 2451e820082b9b97f3ec0d6ba3fbf9d7f8bb17276a8b99ddd1901f60ccc7d214
+  data.tar.gz: aacdea086604b346aa42d022478b8e088bd38f97d91c5b861be7593469eb8f10
 SHA512:
-  metadata.gz: f1846b3909f1fe9948e5e213818df33f763c9c75be9d055ba96149d6bb1f346a4cc1566b5e5b5270d9bb6a1934c03f4411470d48ecf662f5314b8306b77666af
-  data.tar.gz: 204262395c367fab8a0eb6febed30c4420a7bc8191aa872977c087418bd4b0c3bed08739325681a275fa2ddf664eedfa4f51f3520035b0ab53bfc26a82f67181
+  metadata.gz: 9dc72e490d688a7e84e87aed24f3c3071e0aea054eb3a4a5171532841f2f95cf715a278814767bf2ebe25be529a9cc2cff0c07ea38999215404badd750e44bfc
+  data.tar.gz: 512a1a4ec818091f046e22a4cf3d95a14c5d6081940d8be1dc12e148ff515da8ba6a5af08e34beb0c3b1946497aee3268e26ed80bbfea722860b9cb34b6640b4

data/lib/generators/jsonapi/swagger/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create a JSONAPI Swagger
+
+Example:
+    rails generate jsonapi:swagger User
+
+    This will create:
+        spec/requests/users_spec.rb

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

@@ -67,8 +67,15 @@ module Jsonapi
       end
     end
 
-    def safe_encode(comment)
-      comment&.force_encoding('ASCII-8BIT')
+    def t(key, options={})
+      options[:scope] = :jsonapi_swagger
+      options[:default] = key.to_s.humanize
+      content = I18n.t(key, options)
+      safe_encode(content)
+    end
+
+    def safe_encode(content)
+      content&.force_encoding('ASCII-8BIT')
     end
   end
 end

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

@@ -7,16 +7,16 @@ RSpec.describe '<%= resouces_name %>', type: :request do
   end
 
   path '/<%= route_resouces %>' do
-    get '<%= route_resouces %>' do
+    get '<%= route_resouces %> <%= t(:list) %>' 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
-      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '包含字段', required: false
+      parameter name: :'page[number]', in: :query, type: :string, description: '<%= t(:page_num) %>', required: false
+      parameter name: :include, in: :query, type: :string, description: '<%= t(:include_related_data) %>', required: false
+      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% relationships.each_key do |relation| -%>
-      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '包含字段', required: false
+      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
-      response '200', '获取列表' do
+      response '200', '<%= t(:get_list) %>' do
         schema type: :object,
           properties: {
             data: {
@@ -28,9 +28,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                   links: {
                     type: :object,
                     properties: {
-                    self: { type: :string, description: '详情链接'},
+                    self: { type: :string, description: '<%= t(:detail_link) %>'},
                     },
-                    description: '详情链接'
+                    description: '<%= t(:detail_link) %>'
                   },
                   attributes: {
                     type: :object,
@@ -39,7 +39,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                      <%= 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: '属性'
+                    description: '<%= t(:attributes) %>'
                   },
                   relationships: {
                     type: :object,
@@ -52,38 +52,38 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                           links: {
                             type: :object,
                             properties: {
-                              self: { type: :string, description: '关联<%= relation_name_camelize %>列表链接' },
-                              related: { type: :string, description: '相关<%= relation_name_camelize %>链接' },
+                              self: { type: :string, description: '<%= t(:associate_list_link, model: relation_name_camelize) %>' },
+                              related: { type: :string, description: '<%= t(:related_link, model: relation_name_camelize) %>' },
                             },
-                            description: '相关的<%= relation_name_camelize %>链接'
+                            description: '<%= t(:related_link, model: relation_name_camelize)%>'
                           },
                         },
-                        description: '相关<%= relation_name_camelize %>'
+                        description: '<%= t(:related_model, model: relation_name_camelize)%>'
                       },
 <% end -%>
                     },
-                    description: '关联数据'
+                    description: '<%= t(:associate_data) %>'
                   }
               },
             },
-            description: '数据'
+            description: '<%= t(:data) %>'
             },
             meta: {
               type: :object,
               properties: {
-                record_count: { type: :integer, description: '总记录数'},
-                page_count: { type: :integer, description: '页数'},
+                record_count: { type: :integer, description: '<%= t(:record_count) %>'},
+                page_count: { type: :integer, description: '<%= t(:page_count) %>'},
               },
-              description: '分页记录数'
+              description: '<%= t(:meta) %>'
             },
             links: {
               type: :object,
               properties: {
-                first: { type: :string, description: '第一页'},
-                next: { type: :string, description: '下一页'},
-                last: { type: :string, description: '最后一页'},
+                first: { type: :string, description: '<%= t(:first_page_link) %>'},
+                next: { type: :string, description: '<%= t(:next_page_link) %>'},
+                last: { type: :string, description: '<%= t(:last_page_link) %>'},
               },
-              description: '分页链接' },
+              description: '<%= t(:page_links) %>' },
           },
           required: [:data]
         run_test!
@@ -92,16 +92,16 @@ RSpec.describe '<%= resouces_name %>', type: :request do
   end
 
   path '/<%= route_resouces %>/{id}' do
-    get '<%= route_resouces %>详情' do
+    get '<%= route_resouces %> <%= t(:detail) %>' 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
+      parameter name: :include, in: :query, type: :string, description: '<%= t(:include_related_data) %>', required: false
+      parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% relationships.each_key do |relation| -%>
-      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '包含字段', required: false
+      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
-      response '200', '获取详情' do
+      response '200', '<%= t(:get_detail) %>' do
         schema type: :object,
           properties: {
             data: {
@@ -112,9 +112,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                   links: {
                     type: :object,
                     properties: {
-                    self: { type: :string, description: '详情链接'},
+                    self: { type: :string, description: '<%= t(:detail_link) %>'},
                     },
-                    description: '详情链接'
+                    description: '<%= t(:detail_link) %>'
                   },
                   attributes: {
                     type: :object,
@@ -123,7 +123,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                      <%= 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: '属性'
+                    description: '<%= t(:attributes) %>'
                   },
                   relationships: {
                     type: :object,
@@ -136,20 +136,20 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                           links: {
                             type: :object,
                             properties: {
-                              self: { type: :string, description: '关联<%= relation_name_camelize %>列表链接' },
-                              related: { type: :string, description: '相关<%= relation_name_camelize %>链接' },
+                              self: { type: :string, description: '<%= t(:associate_list_link, model: relation_name_camelize) %>' },
+                              related: { type: :string, description: '<%= t(:related_link, model: relation_name_camelize )%>' },
                             },
-                            description: '相关的<%= relation_name_camelize %>链接'
+                            description: '<%= t(:related_link, model: relation_name_camelize) %>'
                           },
                         },
-                        description: '相关<%= relation_name_camelize %>'
+                        description: '<%= t(:related_link, model: relation_name_camelize) %>'
                       },
 <% end -%>
                     },
-                    description: '关联数据'
+                    description: '<%= t(:associate_data) %>'
                   }
             },
-            description: '数据'
+            description: '<%= t(:data) %>'
             },
           },
           required: [:data]

data/lib/i18n/en.yml

@@ -0,0 +1,24 @@
+en:
+  jsonapi_swagger:
+    page_num: 'Page Number'
+    include_related_data: 'Include Related Data'
+    display_field: 'Display Field'
+    list: 'List'
+    get_list: 'Fetch List'
+    detail_link: 'Detail Link'
+    attributes: 'Attributes'
+    associate_list_link: 'Associate to %{model} Link'
+    related_link: 'Related %{model} Link'
+    related_model: 'Related %{model}'
+    associate_data: 'Associate to Date'
+    data: 'Data'
+    record_count: 'Total Record Count'
+    page_count: 'Page Count'
+    meta: 'Meta'
+    first_page_link: 'First Page'
+    next_page_link: 'Next Page'
+    last_page_link: 'Last Page'
+    page_links: 'Page Link'
+    detail: 'Detail'
+    get_dtail: 'Fetch Detail'
+    detail_link: 'Detail Link'

data/lib/i18n/zh-CN.yml

@@ -0,0 +1,24 @@
+zh-CN:
+  jsonapi_swagger:
+    page_num: '页码'
+    include_related_data: '包含关联数据'
+    display_field: '显示字段'
+    list: '列表'
+    get_list: '获取列表'
+    detail_link: '详情链接'
+    attributes: '属性'
+    associate_list_link: '关联%{model}链接'
+    related_link: '相关%{model}链接'
+    related_model: '相关%{model}'
+    associate_data: '关联数据'
+    data: '数据'
+    record_count: '总记录数'
+    page_count: '页数'
+    meta: '元数据'
+    first_page_link: '第一页链接'
+    next_page_link: '下一页链接'
+    last_page_link: '最后一页链接'
+    page_links: '分页链接'
+    detail: '详情'
+    get_dtail: '获取详情'
+    detail_link: '详情链接'

data/lib/jsonapi/swagger.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'jsonapi/swagger/version'
+require 'jsonapi/swagger/railtie' if defined?(Rails)
 
 module Jsonapi
   module Swagger
     class Error < StandardError; end
-    # Your code goes here...
   end
 end

data/lib/jsonapi/swagger/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Jsonapi
+  module Swagger
+    class Railtie < ::Rails::Railtie
+      initializer 'jsonapi-swagger-i18n' do |app|
+        locates = app.config.i18n.available_locales
+        locates_dir = File.expand_path('../../i18n', __dir__)
+        locates.each do |loc|
+          locate_file = File.join(locates_dir, "#{loc}.yml")
+          I18n.load_path.push(locate_file) if File.exist?(locate_file) && !I18n.load_path.include?(locate_file)
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/swagger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2019-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,7 +77,10 @@ files:
 - lib/generators/jsonapi/swagger/USAGE
 - lib/generators/jsonapi/swagger/swagger_generator.rb
 - lib/generators/jsonapi/swagger/templates/swagger.rb.erb
+- lib/i18n/en.yml
+- lib/i18n/zh-CN.yml
 - lib/jsonapi/swagger.rb
+- lib/jsonapi/swagger/railtie.rb
 - lib/jsonapi/swagger/version.rb
 homepage: https://github.com/superiorlu/jsonapi-swagger
 licenses: