Skip to content

Library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents.

License

Notifications You must be signed in to change notification settings

zaytsevand/modelina

Β 
Β 

Repository files navigation

AsyncAPI Modelina

Modelina is the official AsyncAPI SDK to generate data models (i.e. Java/TypeScript classes, Go Structs, etc) from AsyncAPI documents, among other supported inputs.

blackbox pipeline status Coverage Status Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Maintenance score Npm latest version License last commit Discussions Playground All Contributors


πŸ“’ ATTENTION:

This package is currently being prepared to reach version 1.0.0 and the development is therefore happening on the next branch, any features must be based and targetting that branch.


Requirements

Feel free to submit an issue if you require this project in other use-cases.

Installation

Run this command to install Modelina in your project:

npm install @asyncapi/modelina

Once you've successfully installed Modelina in your project, it's time to select your generator. Check out the examples for the specific code.

Features

The following table provides a short summary of available features for supported output languages.

To see the complete feature list for each language, please click the individual links for each language.

Supported inputs description
AsyncAPI We support the following AsyncAPI versions: 2.0.0, 2.1.0, 2.2.0, 2.3.0 and 2.4.0, which generates models for all the defined message payloads.
JSON Schema We support the following JSON Schema versions: Draft-4, Draft-6 and Draft-7
OpenAPI We support the following OpenAPI versions: Swagger 2.0 and OpenAPI 3.0, which generates models for all the defined request and response payloads.
TypeScript file We currently support TypeScript type file as input for model generation

Supported outputs Features
Java Class and enum generation: generation of equals, hashCode, toString, Jackson annotation, custom indentation type and size, etc
TypeScript Class, interface and enum generation: generation of example code, un/marshal functions, custom indentation type and size, etc
C# Class and enum generation: generation of example code, serializer and deserializer functions, custom indentation type and size, etc
Go Struct and enum generation: custom indentation type and size, etc
JavaScript Class generation: custom indentation type and size, etc
Dart Class and enum generation: json_annotation

Roadmap

Documentation

Documentation for this library can be found under the documentation folder.

Examples

Do you need to know how to use the library in certain scenarios?

We have gathered all the examples in a separate folder and they can be found under the examples folder.

Development

To setup your development environment please read the development document.

Contributing

Read our contributor guide.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Maciej UrbaΕ„czyk
Maciej UrbaΕ„czyk

πŸ› πŸ’» πŸ“– πŸ€” 🚧 πŸ’¬ ⚠️ πŸ‘€
czlowiek488
czlowiek488

πŸ› πŸ‘€ πŸ€”
Sergio Moya
Sergio Moya

πŸ› πŸ’» ⚠️ πŸ“– πŸ‘€
Jonas Lagoni
Jonas Lagoni

πŸ› πŸ’» πŸ“– πŸ€” 🚧 πŸ’¬ ⚠️ πŸ‘€
Lukasz Gornicki
Lukasz Gornicki

πŸ‘€ πŸ› πŸ’»
Arjun Garg
Arjun Garg

πŸ’»
Fran MΓ©ndez
Fran MΓ©ndez

πŸ‘€
Kanwal Singh
Kanwal Singh

πŸ’»
Alejandra Quetzalli
Alejandra Quetzalli

πŸ‘€ πŸ“–
MD SAIF  HUSAIN
MD SAIF HUSAIN

πŸ’‘ ⚠️ πŸ“– πŸ’»
Sudipto Ghosh
Sudipto Ghosh

πŸ’‘ ⚠️ πŸ“–
panwauu
panwauu

πŸ’» ⚠️ πŸ’‘ πŸ“– πŸ›
Stefan E. Mayer
Stefan E. Mayer

πŸ›
Talmiz Ahmed
Talmiz Ahmed

πŸ“– ⚠️ πŸ’‘
Marco
Marco

πŸ›
quadrrem
quadrrem

πŸ’» ⚠️
Kamil Janeček
Kamil Janeček

⚠️ πŸ› πŸ’»
mahakporwal02
mahakporwal02

πŸ’‘ ⚠️ πŸ“– πŸ’»
Debajyoti Halder
Debajyoti Halder

πŸ’» ⚠️ πŸ“– πŸ’‘ 🚧
Ritik Rawal
Ritik Rawal

πŸ“– πŸ’» ⚠️ πŸ’‘
Ishan
Ishan

πŸ’» ⚠️
Samriddhi
Samriddhi

πŸ’» ⚠️ πŸ“– πŸ’‘ 🚧
GΓ‘bor Magyar
GΓ‘bor Magyar

πŸ’» ⚠️ πŸ“– πŸ’‘
ibernabeudev
ibernabeudev

πŸ’» ⚠️ πŸ’‘ πŸ“–
Arkadiusz SΕ‚owikowski
Arkadiusz SΕ‚owikowski

πŸ’» ⚠️ πŸ’‘ πŸ“–
Willem Gillis
Willem Gillis

πŸ’» ⚠️ πŸ›
rmasarovic
rmasarovic

πŸ’» πŸ“– ⚠️ πŸ’‘
Owais Hasnath Ahmed
Owais Hasnath Ahmed

πŸ’» ⚠️ πŸ“–
PanMan
PanMan

πŸ“–
artur-ciocanu
artur-ciocanu

πŸ’» πŸ›
Cyprian Gracz
Cyprian Gracz

πŸ’» ⚠️ πŸ›
Leigh Johnson
Leigh Johnson

πŸ’» ⚠️ πŸ’‘ πŸ“– 🚧 πŸ‘€
Nitin Tejuja
Nitin Tejuja

⚠️ πŸ’‘
Kenneth Aasan
Kenneth Aasan

πŸ’» ⚠️
Amit Kumar Sharma
Amit Kumar Sharma

⚠️ πŸ“– πŸ’‘
Tenshi Codes
Tenshi Codes

πŸš‡
Yushi OMOTE
Yushi OMOTE

πŸ› πŸ’»
Zbigniew Malcherczyk
Zbigniew Malcherczyk

πŸ› πŸš‡
200Puls
200Puls

πŸ’» ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.8%
  • Other 0.2%