README.markdown

what

jsonr is a very simple library to create JSON strings in Scala.

repo

Version are available on the Sonatype repository. To use with SBT, add the following line to your build.sbt:

libraryDependencies += "co.torri" %% "scala-jsonr" % "0.5"

using

jsonr can be used in two forms: json description or object serialization. Both forms are described on the following sections. For a full list on how to use it, please check the available unit tests.

In both cases it is necessary to import the lib on where it will be used, like:

import co.torri.jsonr._

json description

In this form JSON objects are described using the special method $. It receive a sequence of key/pairs, which are separated by an arrow symbol (->). All the basic types are supported. An example of this form of usage is:

var json = $(
  "key"   -> "value",
  "int"   -> 2,
  "array" -> List(1, 2, 3),
  "more"  -> List($("foo" -> "bar"))
)

println(json)
// {"key": "value", "int": 2, "array": [1, 2, 3], "more": [{"foo": "bar"}]}

object serialization

Any existent object can be automatically converted to JSON using the special method .toJson:

case class Address(city: String, country: String)
case class Person(name: String, val age: Int, address: Address)
val json = Person("Lucas", 25, Address("Porto Alegre", "BR")).toJson

println(json)
// {"name": "Lucas", "age": 25, "address": {"city": "Porto Alegre", "country": "BR"}}

The same apply for Maps:

val json = Map("one" -> 1, "two" -> 2).toJson

println(json)
// {"one": 1, "two": 2}