Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shootingfly/jbuilder
Generate JSON objects with a Builder-style DSL, inspired by jbuilder
https://github.com/shootingfly/jbuilder
crystal-lang framework jbuilder json kilt template-engine
Last synced: 6 days ago
JSON representation
Generate JSON objects with a Builder-style DSL, inspired by jbuilder
- Host: GitHub
- URL: https://github.com/shootingfly/jbuilder
- Owner: shootingfly
- License: mit
- Created: 2019-08-18T14:45:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-11T10:44:48.000Z (over 3 years ago)
- Last Synced: 2024-10-25T01:24:39.206Z (15 days ago)
- Topics: crystal-lang, framework, jbuilder, json, kilt, template-engine
- Language: Crystal
- Homepage:
- Size: 36.1 KB
- Stars: 44
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - Jbuilder - Generate JSON objects with a Builder-style DSL, inspired by jbuilder (Template Engine)
- awesome-crystal - Jbuilder - Generate JSON objects with a Builder-style DSL, inspired by jbuilder (Template Engine)
README
# Jbuilder
[](https://github.com/shootingfly/jbuilder/actions/workflows/crystal.yml)
[](https://github.com/shootingfly/jbuilder/releases)
Generate JSON objects with a Builder-style DSL, inspired by jbuilder ()
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
jbuilder:
github: shootingfly/jbuilder
```
2. Run `shards install`
## Usage
```crystal
require "jbuilder"
```
First, write down the code.
```crystal
Jbuilder.new do |json|
json.null nil
json.code 200
json.msg "ok"
json.merge!({"code" => 201})
json.array! "array1", [1, 1.0, "1"]
json.array!("array2", [1, 2, 3, 4]) do |json, item|
json.code item
end
json.data do |json|
json.code 400
json.array! "array3", [1, 1.0, "1"]
end
json.set!("custom_field", %w[1 2])
end.to_json
```
Then you can see,
```json
{
"null":null,
"code":201,
"msg":"ok",
"array1":[
1,
1.0,
"1"
],
"array2":[
{
"code":1
},
{
"code":2
},
{
"code":3
},
{
"code":4
}
],
"data":{
"code":400,
"array3":[
1,
1.0,
"1"
]
},
"custom_field":[
"1",
"2"
]
}
```
## An example using Kemal
https://github.com/shootingfly/kemal-jbuilder-example
## Changelog
+ **v1.0.0**
+ Support Crystal 1.0.0
+ **v0.3.0**
+ Support Tuple and Named Tuple
+ Support render with layout and child template
+ **v0.2.0**
+ Support Kilt
+ **v0.1.0**
+ First Release
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Shooting Fly](https://github.com/shootingfly) - creator and maintainer