\n
![\"AsyncAPI](\"https://github.com/asyncapi/parser-nodejs/raw/master/assets/logo.png\"){kind=logo}
\n \n AsyncAPI Model SDK\n
\n \n The official SDK for generating data models from JSON Schema and AsyncAPI spec\n
\n\n[](https://coveralls.io/github/asyncapi/generator-model-sdk?branch=master)\n\n[](#contributors-)\n\n\nAsyncAPI Model SDK is a set of classes/functions for generating data models from JSON Schema and AsyncAPI spec.\n\n---\n\n## :loudspeaker: ATTENTION:\n\nThis package is under development and it has not reached version 1.0.0 yet, which means its API might get breaking changes without prior notice. Once it reaches its first stable version, we'll follow semantic versioning.\n\n---\n\n\n\n\n\n- [Installation](#installation)\n- [How it works](#how-it-works)\n * [The input process](#the-input-process)\n * [The generation process](#the-generation-process)\n- [Example](#example)\n- [Supported input](#supported-input)\n * [AsyncAPI input](#asyncapi-input)\n * [JSON Schema input](#json-schema-input)\n- [Customization](#customization)\n- [Development](#development)\n- [Contributing](#contributing)\n\n\n\n## Installation\n\nRun this command to install the SDK in your project:\n\n```bash\nnpm install --save @asyncapi/generator-model-sdk\n```\n\n## How it works\n\nThe process of creating data models from input data consists of 2 processes, the input and generation process.\n\n### The input process\n\nThe input process ensures that any supported input is handled correctly, the basics are that any input needs to be converted into our internal model representation `CommonModel`. The following inputs are supported:\n\n- [JSON Schema Draft 7](#JSON-Schema-input), this is the default inferred input if we cannot find another input processor.\n- [AsyncAPI version 2.0.0](#AsyncAPI-input)\n\nRead more about the input process [here](./docs/input_processing.md).\n\n### The generation process\n\nThe generation process uses the predefined `CommonModel`s from the input stage to easily generate models regardless of input. The package supports the following output languages:\n\n- JavaScript\n- TypeScript\n- Java\n\nCheck out [the example](#example) to see how to use the library and [generators document](./docs/generators.md) for more info.\n\n> **NOTE**: Each implemented language has different options, dictated by the nature of the language. Keep this in mind when selecting a language.\n\n## Example\n\n```js\nimport { TypeScriptGenerator } from '@asyncapi/generator-model-sdk';\n\nconst generator = new TypeScriptGenerator({ modelType: 'interface' });\n\nconst doc = {\n $id: \"Address\",\n type: \"object\",\n properties: {\n street_name: { type: \"string\" },\n city: { type: \"string\", description: \"City description\" },\n state: { type: \"string\" },\n house_number: { type: \"number\" },\n marriage: { type: \"boolean\", description: \"Status if marriage live in given house\" },\n pet_names: { type: \"array\", items: { type: \"string\" } },\n state: { type: \"string\", enum: [\"Texas\", \"Alabama\", \"California\", \"other\"] },\n },\n required: [\"street_name\", \"city\", \"state\", \"house_number\", \"state\"],\n};\n\nconst interfaceModel = await generator.generate(doc);\n\n// interfaceModel[0] should have the shape:\ninterface Address {\n streetName: string;\n city: string;\n state: string;\n houseNumber: number;\n marriage?: boolean;\n petNames?: Array![\"\"/](\"https://avatars.githubusercontent.com/u/20404945?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/34620109?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/1083296?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/13396189?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/6995927?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/53009722?v=4?s=100\")
![\"\"/](\"https://avatars.githubusercontent.com/u/242119?v=4?s=100\")