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

pontus-eliason/modelina

 
 

Repository files navigation


AsyncAPI logo
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 still under development and has not reached version 1.0.0 yet. This means that its API may contain breaking changes until we're able to deploy the first stable version and begin semantic versioning. Please use tests to ensure expected outputs or to hardcode the version.


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 and 2.3.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

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

🐛 💻 📖 🤔 🚧 💬 ⚠️ 👀

czlowiek488

🐛 👀 🤔

Sergio Moya

🐛 💻 ⚠️ 📖 👀

Jonas Lagoni

🐛 💻 📖 🤔 🚧 💬 ⚠️ 👀

Lukasz Gornicki

👀 🐛 💻

Arjun Garg

💻

Fran Méndez

👀

Kanwal Singh

💻

Alejandra Quetzalli

👀 📖

MD SAIF HUSAIN

💡 ⚠️ 📖 💻

Sudipto Ghosh

💡 ⚠️ 📖

panwauu

💻 ⚠️ 💡 📖 🐛

Stefan E. Mayer

🐛

Talmiz Ahmed

📖 ⚠️ 💡

Marco

🐛

quadrrem

💻 ⚠️

Kamil Janeček

⚠️ 🐛 💻

mahakporwal02

💡 ⚠️ 📖 💻

Debajyoti Halder

💻 ⚠️ 📖 💡 🚧

Ritik Rawal

📖 💻 ⚠️ 💡

Ishan

💻 ⚠️

Samriddhi

💻 ⚠️ 📖 💡 🚧

Gábor Magyar

💻 ⚠️ 📖 💡

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

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.7%
  • Other 0.3%