https://github.com/i2bskn/schema_serializer
SchemaSerializer is provide serialization from schema definition to JSON.
https://github.com/i2bskn/schema_serializer
json openapi serializer
Last synced: 7 months ago
JSON representation
SchemaSerializer is provide serialization from schema definition to JSON.
- Host: GitHub
- URL: https://github.com/i2bskn/schema_serializer
- Owner: i2bskn
- License: mit
- Created: 2018-07-23T17:25:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-03-21T05:36:56.000Z (almost 5 years ago)
- Last Synced: 2025-03-27T13:11:22.633Z (10 months ago)
- Topics: json, openapi, serializer
- Language: Ruby
- Homepage:
- Size: 67.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SchemaSerializer
[](https://badge.fury.io/rb/schema_serializer)
[](https://github.com/i2bskn/schema_serializer/actions?query=workflow%3ACI)
SchemaSerializer is provide serialization from schema definition to JSON.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "schema_serializer"
```
And then execute:
```bash
$ bundle install
```
Create config file(Only Rails) with:
```bash
$ bundle exec rails generate schema_serializer:install
```
The following file will be created.
- `config/initializers/schema_serializer.rb`
- `doc/schema.yml`
## Usage
### Create a serializer template with Rails Generator
Create a serializer template in `app/serializers/user_serializer.rb`.
```bash
$ bundle exec rails g schema_serializer:serializer User
```
### Serializer Definitions
Serializer Definitions are describe in the `doc/schema.yml`.
```yaml
User:
required:
- id
- name
properties:
id:
type: integer
name:
type: string
age:
type: integer
nullable: true
```
### Serialization
```ruby
user = User.take
SchemaSerializer.new(user).as_json.to_json
# Only ActiveRecord Object
user.serializer.as_json.to_json
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/i2bskn/schema_serializer.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).