{"id":21766045,"url":"https://github.com/narazaka/swagger-serializer","last_synced_at":"2025-04-13T15:12:12.813Z","repository":{"id":56896879,"uuid":"224905174","full_name":"Narazaka/swagger-serializer","owner":"Narazaka","description":"Swagger (OpenAPI 3) schema based serializer for ruby","archived":false,"fork":false,"pushed_at":"2022-11-21T07:45:40.000Z","size":59,"stargazers_count":12,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T15:12:00.778Z","etag":null,"topics":["openapi","openapi3","rails","ruby","serializer","swagger"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"zlib","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Narazaka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-29T18:34:41.000Z","updated_at":"2022-11-18T11:26:05.000Z","dependencies_parsed_at":"2022-08-20T17:40:33.916Z","dependency_job_id":null,"html_url":"https://github.com/Narazaka/swagger-serializer","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-serializer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-serializer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-serializer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Narazaka%2Fswagger-serializer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Narazaka","download_url":"https://codeload.github.com/Narazaka/swagger-serializer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248732489,"owners_count":21152852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","openapi3","rails","ruby","serializer","swagger"],"created_at":"2024-11-26T13:14:58.830Z","updated_at":"2025-04-13T15:12:12.787Z","avatar_url":"https://github.com/Narazaka.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swagger::Serializer\n\n[![Actions Status](https://github.com/Narazaka/swagger-serializer/workflows/Ruby/badge.svg)](https://github.com/Narazaka/swagger-serializer/actions)\n[![Gem Version](https://badge.fury.io/rb/swagger-serializer.svg)](https://badge.fury.io/rb/swagger-serializer)\n\nSwagger (OpenAPI 3) schema based serializer.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'swagger-serializer'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install swagger-serializer\n\n## Usage\n\n### Rails with swagger-dsl\n\nuse \"[swagger-dsl](https://github.com/Narazaka/swagger-dsl)\"!\n\nLoad it in initializer.\n\n```ruby\n# config/initializers/swagger_serializer.rb\n\nif Rails.application.config.eager_load\n  Swagger::DSL.current.config.lazy_define_paths = true\n  Rails.application.config.after_initialize do\n    Rails.application.reload_routes!\n    Swagger::DSL.current.define_paths!\n    Swagger::Schema.current = Swagger::Schema.new(Swagger::DSL.current.resolved)\n  end\nelse\n  Swagger::Schema.current = Swagger::Schema.new(Swagger::DSL.current)\n  Swagger::Serializer::Store.current.serialize_options[:resolver] = Swagger::DSL.current.resolver\n  Swagger::Serializer::Store.current.deserialize_options[:resolver] = Swagger::DSL.current.resolver\nend\n```\n\nUse it in controllers.\n\n```ruby\n# app/controllers/application_controller.rb\nclass ApplicationController \u003c ActionController::Base\n  include Swagger::Serializer::RailsController\n  extend Swagger::DSL::RailsController\n\n  def render_ok(data, context = nil)\n    render_as_schema 200, :json, data, context\n  end\n\n  def render_bad(data, context = nil)\n    render_as_schema 400, :json, data, context\n  end\nend\n```\n\n```ruby\n# app/controllers/users_controller.rb\nclass UsersController \u003c ApplicationController\n  swagger :index do\n    render 200 do\n      array! { cref! UserSerializer }\n    end\n  end\n  def index\n    render_ok User.all\n  end\n\n  swagger :show do\n    params do\n      path :id, schema: :integer\n    end\n\n    render 200 do\n      cref! UserSerializer\n    end\n  end\n  def show\n    render_ok User.find(schema_params[:id])\n  end\n\n  swagger :create do\n    body format: [:form, :json] do\n      user :object do\n        name :string\n      end\n    end\n    \n    render 200 do\n      cref! UserSerializer\n    end\n    render 400 do\n      additionalProperties! do\n        array! { string! }\n      end\n    end\n  end\n  def create\n    @user = User.new(schema_params[:user])\n\n    if @user.save\n      render_ok @user\n    else\n      render_bad @user.errors\n    end\n  end\n\n  swagger :update do\n    params do\n      path :id, schema: :string\n    end\n\n    body format: [:form, :json] do\n      user :object do\n        name :string\n      end\n    end\n    \n    render 200 do\n      cref! UserSerializer\n    end\n    render 400 do\n      additionalProperties! do\n        array! { string! }\n      end\n    end\n  end\n  def update\n    @user = User.find(schema_params[:id])\n\n    if @user.update(schema_params[:user])\n      render_ok @user\n    else\n      render_bad @user.errors\n    end\n  end\n\n  swagger :destroy do\n    params do\n      path :id, schema: :string\n    end\n  end\n  def destroy\n    @user.destroy!\n    head :no_content\n  end\nend\n```\n\nWould you want to customize serialization?\n\n```ruby\n# app/serializers/base_serializer.rb\nclass BaseSerializer\n  include Swagger::Serializer\n  extend Swagger::DSL::Serializer\nend\n```\n\n```ruby\n# app/serializers/user_serializer.rb\nclass UserSerializer \u003c BaseSerializer\n  swagger do\n    id :integer\n    name :string, optional: true\n  end\n\n  def name\n    \"#{@model.name}!!!!\"\n  end\nend\n```\n\nNow you can get `{ \"id\" =\u003e 42, \"name\" =\u003e \"me!!!!\" }`.\n\nThis serializer class detection uses the schema's `title` key.\nIf you want to use `Foo::BarSerializer`, set `Foo-Bar` to `title` key.\n\nThe key is configurable by\n\n```ruby\n# in config/initializers/swagger_serializer.rb\nSwagger::Serializer::Store.current.serialize_options[:inject_key] = \"my_inject_key\"\nSwagger::Serializer::Store.current.deserialize_options[:inject_key] = \"my_inject_key\"\nSwagger::DSL.current.config.inject_key = \"my_inject_key\"\n```\n\nSometimes model needs direct serialize.\n\n```ruby\n# app/models/application_record.rb\nclass ApplicationRecord \u003c ActiveRecord::Base\n  self.abstract_class = true\n  \n  include Swagger::Serializer::Model\nend\n```\n\nNow you can get serialized result by `p User.first.serialize`.\n\n### Rails with raw schema\n\nWrite your OpenAPI spec.\n\n```yaml\n# swagger.yml\nopenapi: 3.0.0\ninfo:\n  title: example api\n  version: 0.1.0\ncomponents:\n  schemas:\n    User: \u0026User\n      title: User\n      type: object\n      properties:\n        id:\n          type: integer\n        name:\n          type: string\n      required: [id]\npaths:\n  /users:\n    get:\n      responses:\n        200:\n          content:\n            application/json:\n              schema:\n                type: array\n                items: *User\n  /users/{id}:\n    get:\n      responses:\n        200:\n          content:\n            application/json:\n              schema: *User\n\n```\n\nLoad it in initializer.\n\n```ruby\n# config/initializers/swagger_serializer.rb\n\nSwagger::Schema.load_file_to_current(\n  __dir__ + \"/../../swagger.yml\",\n)\n```\n\nUse it in controllers.\n\n```ruby\n# app/controllers/application_controller.rb\nclass ApplicationController \u003c ActionController::Base\n  include Swagger::Serializer::RailsController\n\n  def render_ok(data, context = nil)\n    render_as_schema 200, :json, data, context\n  end\nend\n```\n\n```ruby\n# app/controllers/users_controller.rb\nclass UsersController \u003c ApplicationController\n  def index\n    render_ok User.all\n  end\n\n  def show\n    render_ok User.find(params[:id])\n  end\nend\n```\n\nWould you want to customize serialization?\n\n```ruby\n# app/serializers/base_serializer.rb\nclass BaseSerializer\n  include Swagger::Serializer\nend\n```\n\n```ruby\n# app/serializers/user_serializer.rb\nclass UserSerializer \u003c BaseSerializer\n  def name\n    \"#{@model.name}!!!!\"\n  end\nend\n```\n\nNow you can get `{ \"id\" =\u003e 42, \"name\" =\u003e \"me!!!!\" }`.\n\nSometimes model needs direct serialize.\n\n```ruby\n# app/models/application_record.rb\nclass ApplicationRecord \u003c ActiveRecord::Base\n  self.abstract_class = true\n  \n  include Swagger::Serializer::Model\nend\n```\n\nNow you can get serialized result by `p User.first.serialize`.\n\n### @context\n\nCollection serialization sometimes needs context data for avoiding N+1 access or some other reason.\n\n`render_as_schema`'s 4th parameter is the context that will be passed to serializers `@context`.\n\n```ruby\n# app/serializers/item_serializer.rb\nclass ItemSerializer \u003c BaseSerializer\n  swagger do\n    id :integer\n    rate :integer\n  end\n\n  def rate\n    @context[:rates][id]\n  end\nend\n\n# app/controllers/items_controller.rb\nclass ItemsController \u003c ApplicationController\n  swagger :index do\n    render 200 do\n      array! do\n        cref! ItemSerializer\n      end\n    end\n  end\n\n  def index\n    items = Item.all\n    rates = ItemRate.calc_item_rates(items)\n    render_ok items, { rates: rates }\n  end\nend\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/Narazaka/swagger-serializer.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnarazaka%2Fswagger-serializer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnarazaka%2Fswagger-serializer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnarazaka%2Fswagger-serializer/lists"}