Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahrefs/jsonschema2atd
Generate ATD types from a JSON schema / OpenAPI document
https://github.com/ahrefs/jsonschema2atd
atd jsonschema ocaml openapi
Last synced: 8 days ago
JSON representation
Generate ATD types from a JSON schema / OpenAPI document
- Host: GitHub
- URL: https://github.com/ahrefs/jsonschema2atd
- Owner: ahrefs
- License: mit
- Created: 2023-12-20T16:36:19.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-08-01T11:33:24.000Z (4 months ago)
- Last Synced: 2024-10-31T09:50:23.542Z (15 days ago)
- Topics: atd, jsonschema, ocaml, openapi
- Language: Perl
- Homepage:
- Size: 90.8 KB
- Stars: 19
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonschema2atd
Generate an [ATD](https://github.com/ahrefs/atd) file from a JSON Schema / OpenAPI document.
## Installation
The package is available on [opam](https://ocaml.org/p/jsonschema2atd/latest).
```
opam install jsonschema2atd
```
If you wish to install the development version you can do so with:
```bash
make install
```
## Usage
Generate an ATD file from a JSON Schema:
```bash
jsonschema2atd ../path-to-jsonschema.json
```
Generate an ATD file from an OpenAPI document:
```bash
jsonschema2atd --format openapi ../path-to-openapi.json
```
You 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}))))
```
## ToDo
- [X] Base types
- [X] Records
- [X] Nullable
- [X] String enums
- [ ] Integer enums
- [ ] Other primitive enums
- [X] Refs (OpenAPI format)
- [X] OneOf (Only serialization is supported)
- [ ] not
- [ ] anyOf
- [X] allOf