jsonapi-swagger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea93978c9a08288cd98899e5d3503a270be4093954bb073689f0c026771dc7ad
+  data.tar.gz: 0a1d89cb33b692d5fd460b03d5a7983f9b24bbdf92a6563c1cd165eb2d47e825
+SHA512:
+  metadata.gz: ebe4803bee8ad8f5f0b52797c9ebdad9f6a425d3b308c58cbcc119fe43da9d4ff1732e9e4c195db34f0c3eb9df83ee1d9349650132ecfe079bcd3cd4305283ad
+  data.tar.gz: d845a4f4e6147dbe2c74e89802177834a67f9f1dd9d06e4c827659b639de98277a6d5757ad95b27ac43712bb89f64ea6c3c13b0a9bca29746fa20122ff0a45a1

data/README.md

@@ -0,0 +1,29 @@
+# JSONAPI Swagger
+
+Create a JSONAPI Swagger.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-swagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-swagger
+
+## Usage
+
+```sh
+rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/superiorlu/jsonapi-swagger.

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

@@ -0,0 +1,68 @@
+module Jsonapi
+  class SwaggerGenerator < Rails::Generators::NamedBase
+    desc 'Create a JSONAPI Swagger.'
+    source_root File.expand_path('templates', __dir__)
+
+    def create_swagger_file
+      swagger_file = File.join(
+        'spec/requests',
+        class_path,
+        spec_file_name
+      )
+      template 'swagger.rb.erb', swagger_file
+    end
+
+    private
+
+    def spec_file_name
+      "#{file_name.downcase.pluralize}_spec.rb"
+    end
+
+    def resouces_name
+      model_class_name.pluralize
+    end
+
+    def route_resouces
+      resouces_name.downcase.gsub('::', '/')
+    end
+
+    def model_class_name
+      (class_path + [file_name]).map!(&:camelize).join("::")
+    end
+
+    def model_klass
+      model_class_name.safe_constantize
+    end
+
+    def resource_klass
+      "#{model_class_name}Resource".safe_constantize
+    end
+
+    def attributes
+      resource_klass._attributes.except(:id)
+    end
+
+    def relationships
+      resource_klass._relationships
+    end
+
+    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) }
+        end
+      end
+    end
+
+    def swagger_type(type)
+      case type
+      when :bigint, :integer then 'integer'
+      else 'string'
+      end
+    end
+
+    def safe_encode(comment)
+      comment&.force_encoding('ASCII-8BIT')
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+require 'swagger_helper'
+RSpec.describe '<%= resouces_name %>', type: :request do
+<% if resource_klass.immutable -%>
+  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
+<% end -%>
+      response '200', '获取列表' do
+        schema type: :object,
+          properties: {
+            data: {
+              type: :array,
+              items: {
+                type: :object,
+                properties: {
+                  id: { type: :integer, description: 'ID'},
+                  links: {
+                    type: :object,
+                    properties: {
+                    self: { type: :string, description: '详情链接'},
+                    },
+                    description: '详情链接'
+                  },
+                  attributes: {
+                    type: :object,
+                    properties: {
+<% attributes.keys.each do |attr| -%>
+                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
+<% end -%>
+                    },
+                    description: '属性'
+                  },
+                  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: '关联<%= relation_name_camelize %>列表链接' },
+                              related: { type: :string, description: '相关<%= relation_name_camelize %>链接' },
+                            },
+                            description: '相关的<%= relation_name_camelize %>链接'
+                          },
+                        },
+                        description: '相关<%= relation_name_camelize %>'
+                      },
+<% end -%>
+                    },
+                    description: '关联数据'
+                  }
+              },
+            },
+            description: '数据'
+            },
+            meta: {
+              type: :object,
+              properties: {
+                record_count: { type: :integer, description: '总记录数'},
+                page_count: { type: :integer, description: '页数'},
+              },
+              description: '分页记录数'
+            },
+            links: { type: :array, items: { type: :string }, description: '分页链接' },
+          },
+          required: [:data]
+        run_test!
+      end
+    end
+  end
+
+  path '/<%= route_resouces %>/{id}' do
+    get '<%= route_resouces %>详情' do
+      tags '<%= route_resouces %>'
+      produces 'application/vnd.api+json'
+      parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
+
+      response '200', '获取详情' do
+        schema type: :object,
+          properties: {
+            data: {
+              type: :array,
+              items: {
+                type: :object,
+                properties: {
+                  id: { type: :integer, description: 'ID'},
+                  links: {
+                    type: :object,
+                    properties: {
+                    self: { type: :string, description: '详情链接'},
+                    },
+                    description: '详情链接'
+                  },
+                  attributes: {
+                    type: :object,
+                    properties: {
+<% attributes.keys.each do |attr| -%>
+                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
+<% end -%>
+                    },
+                    description: '属性'
+                  },
+                  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: '关联<%= relation_name_camelize %>列表链接' },
+                              related: { type: :string, description: '相关<%= relation_name_camelize %>链接' },
+                            },
+                            description: '相关的<%= relation_name_camelize %>链接'
+                          },
+                        },
+                        description: '相关<%= relation_name_camelize %>'
+                      },
+<% end -%>
+
+
+
+                    },
+                    description: '关联数据'
+                  }
+              },
+            },
+            description: '数据'
+            },
+          },
+          required: [:data]
+        run_test!
+      end
+    end
+  end
+<% else -%>
+<% end -%>
+end

data/lib/jsonapi/swagger/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jsonapi
+  module Swagger
+    VERSION = '0.1.0'
+  end
+end

data/lib/jsonapi/swagger.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'jsonapi/swagger/version'
+
+module Jsonapi
+  module Swagger
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-swagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YingRui Lu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+- !ruby/object:Gem::Dependency
+  name: rswag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- yingruilu518@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/jsonapi/swagger/USAGE
+- lib/generators/jsonapi/swagger/swagger_generator.rb
+- lib/generators/jsonapi/swagger/templates/swagger.rb.erb
+- lib/jsonapi/swagger.rb
+- lib/jsonapi/swagger/version.rb
+homepage: https://github.com/superiorlu/jsonapi-swagger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: JSON API Swagger Doc Generator
+test_files: []