Generate an ATD file from a JSON Schema / OpenAPI document.
The package is available on opam.
opam install jsonschema2atd
If you wish to install the development version you can do so with:
make installGenerate an ATD file from a JSON Schema:
jsonschema2atd ../path-to-jsonschema.jsonGenerate an ATD file from an OpenAPI document:
jsonschema2atd --format openapi ../path-to-openapi.jsonYou can call jsonschema2atd and atdgen in your dune file to generate OCaml types and JSON serializers/deserializers from your JSON Schema or OpenAPI document:
; Add jsonschema2atd.runtime to have access to the oneOf serialization adapter (for variant unboxing).
(library
...
(libraries ... jsonschema2atd.runtime))
; Generate dashboard_gen.atd from the dashboard_types_gen.json OpenAPI document with jsonschema2atd.
(rule
(target dashboard_gen.atd)
; Store the generated .atd file in the code.
(mode promote)
(deps ../grok/dashboard_types_gen.json)
(action
(with-stdout-to
%{target}
(run
%{bin:jsonschema2atd} -f openapi
%{deps}))))
; Generate dashboard_gen_t.mli, dashboard_gen_t.ml, dashboard_gen_j.mli, and dashboard_gen_j.ml from dashboard_gen.atd with atdgen.
(rule
(targets
dashboard_gen_t.mli
dashboard_gen_t.ml
dashboard_gen_j.mli
dashboard_gen_j.ml)
(deps dashboard_gen.atd)
(action
(progn
(run %{bin:atdgen} -j -j-std -j-defaults %{deps})
(run %{bin:atdgen} -t %{deps}))))
- Base types
- Records
- Nullable
- String enums
- Integer enums
- Other primitive enums
- Refs (OpenAPI format)
- OneOf (Only serialization is supported)
- not
- anyOf
- allOf
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent