https://github.com/gridpoint-com/ostara
🐇 Transform Ecto schemas into JSON Schemas
https://github.com/gridpoint-com/ostara
ecto elixir json-schema
Last synced: 4 months ago
JSON representation
🐇 Transform Ecto schemas into JSON Schemas
- Host: GitHub
- URL: https://github.com/gridpoint-com/ostara
- Owner: gridpoint-com
- License: mit
- Created: 2023-03-16T18:27:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T19:16:13.000Z (over 1 year ago)
- Last Synced: 2025-10-21T18:44:37.922Z (8 months ago)
- Topics: ecto, elixir, json-schema
- Language: Elixir
- Homepage: https://hex.pm/packages/ostara
- Size: 67.4 KB
- Stars: 1
- Watchers: 16
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ostara
[][Contributor Covenant]
Transforms [Ecto] schema modules into [JSON Schema] structures.
[Ostara _(1901) by Johannes Gehrts_][art]
**Note:** Ostara is under active development and does not yet support all features of Ecto or the full JSON Schema specification. Contributions are welcome!
## Example
Given the following schema module:
```elixir
defmodule Product do
@moduledoc "A product from Acme's catalog"
use Ecto.Schema
@primary_key false
embedded_schema do
field :product_name, :string
field :price, :float
end
def changeset(data, params) do
data
|> cast(params, [:product_name, :price])
|> validate_required([:product_name])
|> validate_number(:price, greater_than: 0)
end
end
```
Ostara will produce the following JSON data:
```elixir
%{
"$schema" => "https://json-schema.org/draft/2020-12/schema",
"$id" => "product",
"title" => "Product",
"type" => "object",
"description" => "A product from Acme's catalog",
"properties" => %{
"product_name" => %{
"type" => "string"
},
"price" => %{
"type" => "number",
"exclusiveMinimum" => 0
}
},
"required" => ["product_name"]
}
```
## Installation
Ostara is [available in Hex] and can be installed by adding `ostara` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ostara, "~> 0.4.0"}
]
end
```
## License
Ostara source code is released under Apache License 2.0. See
[LICENSE][LICENSE] for more information.
[Contributor Covenant]: https://github.com/gridpoint-com/ostara/blob/main/CODE_OF_CONDUCT.md
[Ecto]: https://hexdocs.pm/ecto/Ecto.html
[JSON Schema]: https://json-schema.org/
[LICENSE]: https://github.com/gridpoint-com/ostara/blob/main/LICENSE
[art]: https://commons.wikimedia.org/wiki/File:Ostara_by_Johannes_Gehrts.jpg
[available in Hex]: https://hex.pm/ostara