swagger-serializer 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9117f21413014f63963039d2bc4b9bd5af69822848e7171ab138db2f577e426f
-  data.tar.gz: 9f8b7698fb58f7519642ca076962928ec7fbc6503307432e0f42a97900a20738
+  metadata.gz: a3b95443bcdbd807222b38fe709504b87c73ded014428c3b097e477f798352b1
+  data.tar.gz: 74dc8b92f4b88bbb6e631e099cb2a5ccc0700386836356e6b222b21d0f247a80
 SHA512:
-  metadata.gz: 8cf2998a61d2755e0ac01ece1cf2d03e63e52013eb82add89a2fdc85d0249754ca8054dfb2edaf54bbb90bb9c5ef07280cabb1d0c946f749551a2e628cc7a330
-  data.tar.gz: e46a73c62aa9e9d4217943df68d943b3370dd14da3b6c0db13b4897c7931177bc5379b1d4fed0ee9a653e1a10e51af46cf2cc17b35f579a97ef35bed9d1fcc64
+  metadata.gz: 66c21502bb24dafdf67de2b0c8d29204f25c5269fd0025ad0385f6cd04588363edd87d51a08e4c5460ff271bb63dc85a059dd29cc0a30f0d0d3f1e16fc5118d3
+  data.tar.gz: 7629f949146f38f9065b6401aecd7953b0086bfa4544b1d29b90c1400fd2e7746f81439109f92520c41da7771e83e8db46f28cff6ebc52a08500dc41f7eafe92

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.4.0
+
+- change store interface
+
+## 0.3.0
+
+- change store interface
+
 ## 0.2.0
 
 - implove: injectors

data/README.md

@@ -23,13 +23,123 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails
+### Rails with swagger-dsl
+
+use "[swagger-dsl](https://github.com/Narazaka/swagger-dsl)"!
+
+Load it in initializer.
+
+```ruby
+# config/initializers/swagger_serializer.rb
+
+if Rails.application.config.eager_load
+  Rails.application.config.after_initialize do
+    Swagger::Schema.current = Swagger::Schema.new(Swagger::DSL.current.resolved)
+  end
+else
+  Swagger::Schema.current = Swagger::Schema.new(Swagger::DSL.current)
+  Swagger::Serializer::Store.current.options[:resolver] = Swagger::DSL.current.resolver
+end
+```
+
+Use it in controllers.
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  include Swagger::Serializer::RailsController
+
+  def render_ok(data)
+    render_as_schema 200, :json, data
+  end
+end
+```
+
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  swagger :index do
+    render 200 do
+      array! { cref! UserSerializer }
+    end
+  end
+
+  def index
+    render_ok User.all
+  end
+
+  swagger :show do
+    params do
+      path :id, schema: :integer, required: true
+    end
+
+    render 200 do
+      cref! UserSerializer
+    end
+  end
+
+  def show
+    render_ok User.find(params[:id])
+  end
+end
+```
+
+Would you want to customize serialization?
+
+```ruby
+# app/serializers/base_serializer.rb
+class BaseSerializer
+  include Swagger::Serializer
+end
+```
+
+```ruby
+# app/serializers/user_serializer.rb
+class UserSerializer < BaseSerializer
+  swagger do
+    id :integer
+    name :string, optional: true
+  end
+
+  def name
+    "#{@model.name}!!!!"
+  end
+end
+```
+
+Now you can get `{ "id" => 42, "name" => "me!!!!" }`.
+
+This serializer class detection uses the schema's `title` key.
+If you want to use `Foo::BarSerializer`, set `Foo::Bar` to `title` key.
+
+The key is configurable by
+
+```ruby
+# in config/initializers/swagger_serializer.rb
+Swagger::Serializer::Store.current.options[:inject_key] = "my_inject_key"
+Swagger::DSL.current.config.inject_key = "my_inject_key"
+```
+
+Sometimes model needs direct serialize.
+
+```ruby
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+  
+  include Swagger::Serializer::Model
+end
+```
+
+Now you can get serialized result by `p User.first.serialize`.
+
+### Rails with raw schema
 
 Write your OpenAPI spec.
 
 ```yaml
 # swagger.yml
-openapi: "3.0"
+openapi: 3.0.0
 info:
   title: example api
   version: 0.1.0
@@ -71,16 +181,6 @@ Load it in initializer.
 Swagger::Schema.load_file_to_current(
   __dir__ + "/../../swagger.yml",
 )
-
-# Swagger::Schema accepts lazy load. So your swagger schema data instance may also be accepted.
-#
-# class SwaggerData
-#   def paths
-#     load_paths_now
-#   end
-# end
-#
-# Swagger::Schema.current = Swagger::Schema.new(SwaggerData.new)
 ```
 
 Use it in controllers.

data/lib/swagger/serializer/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Serializer
-    VERSION = "0.4.0".freeze
+    VERSION = "0.4.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-30 00:00:00.000000000 Z
+date: 2019-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema-serializer
@@ -234,7 +234,7 @@ metadata:
   homepage_uri: https://github.com/Narazaka/swagger-serializer
   source_code_uri: https://github.com/Narazaka/swagger-serializer.git
   changelog_uri: https://github.com/Narazaka/swagger-serializer/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/swagger-serializer/0.4.0
+  documentation_uri: https://www.rubydoc.info/gems/swagger-serializer/0.4.1
 post_install_message: 
 rdoc_options: []
 require_paths: