Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jirihausner/zio-schema-circe
Circe integration into ZIO Schema ecosystem.
https://github.com/jirihausner/zio-schema-circe
circe json scala schema zio
Last synced: 14 days ago
JSON representation
Circe integration into ZIO Schema ecosystem.
- Host: GitHub
- URL: https://github.com/jirihausner/zio-schema-circe
- Owner: jirihausner
- License: apache-2.0
- Created: 2024-10-15T17:44:17.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-19T13:35:56.000Z (17 days ago)
- Last Synced: 2025-01-19T14:44:25.585Z (17 days ago)
- Topics: circe, json, scala, schema, zio
- Language: Scala
- Homepage:
- Size: 164 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zio-schema-circe
`zio-schema-circe` seamlessly integrates [zio-schema](https://github.com/zio/zio-schema) with the widely used [Circe](https://circe.github.io/circe/) JSON library.
  [](https://github.com/scala-steward-org/scala-steward) [](https://github.com/jirihausner/zio-schema-circe)
## Why zio-schema-circe?
- Perfect for projects that already use Circe that want to take advantage of the type-safe schema definitions of `zio-schema`.
- Provides an alternative to [zio-schema-json](https://github.com/zio/zio-schema/tree/main/zio-schema-json), catering to teams already invested in Circe's ecosystem.
- Makes it easier to gradually migrate to `zio-schema` or incorporate its features into legacy stacks.
## Installation
In order to use this library, we need to add one (or more) of the following lines in our `build.sbt` file:
```scala
libraryDependencies += "io.github.jirihausner" %% "zio-schema-circe" % "0.1.0"
libraryDependencies += "io.github.jirihausner" %% "zio-schema-circe-jsoniter" % "0.1.0"
```
## Example
```scala
import io.circe.Codec
import io.circe.syntax._
import io.circe.parser.decode
import zio.schema.codec.circe.CirceCodec
import zio.schema.{DeriveSchema, Schema}
case class Person(name: String, age: Int)
object Person {
implicit val schema: Schema[Person] = DeriveSchema.gen
}
// derive Circe codecs from Schema
implicit val codec: Codec[Person] = CirceCodec.schemaCodec(Person.schema)
decode[Person]("""{"name": "John", "age": 30}""") // Person("John", 30)
Person("Adam", 24).asJson.noSpaces // {"Adam": 24}
// use existing Circe codecs as BinaryCodec
import io.circe.generic.semiauto.deriveCodec
import zio.schema.codec.circe.CirceCodec.circeBinaryCodec
circeBinaryCodec[Person](deriveCodec) // zio.schema.codec.BinaryCodec[Person]
// derive circe BinaryCodec from schema
import zio.schema.codec.circe.CirceCodec.schemaBasedBinaryCodec
schemaBasedBinaryCodec[Person](CirceCodec.Config.default) // zio.schema.codec.BinaryCodec[Person]
```
## Acknowledgements
This library was heavily inspired by [zio-schema-json](https://github.com/zio/zio-schema/tree/main/zio-schema-json). Huge thanks to its original contributors for laying foundational ideas and implementation, which greatly influenced `zio-schema-circe`.
## Disclaimer
`zio-schema-circe` is not intended to compete with `zio-schema-json`. Instead, it serves as a complementary option for developers who prefer or already use Circe in their stack.
---
Contributions are welcome! If you have suggestions, improvements, or feature requests, feel free to open an issue or a pull request.