feat: support Swagger 2.0 as input (#378)

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

Author: jonaslagoni

README.md

@@ -73,6 +73,10 @@ To see the complete feature list for each language, please click the individual
     <td><a href="./docs/usage.md">JSON Schema</a></td>
     <td>We support the following JSON Schema versions: <em>Draft-7</em></td>
   </tr>
+  <tr>
+    <td><a href="./docs/usage.md">OpenAPI</a></td>
+    <td>We support the following OpenAPI versions: <em>Swagger 2.0</em></td>
+  </tr>
 </table>
 
 <a id="outputs"></a>

docs/README.md

@@ -30,17 +30,14 @@ Contains many advanced ways to integrate Modelina _(i.e. websites)_.
 ### [Development](./development.md)
 Explains how to setup the project for development. 
 
-### [Input processing](./input_processing.md)
-Details how input processing works.
-
 ### [Generators](./generators.md)
 Details which different generator options are supported.
 
 ### [Presets](./presets.md)
 Goes more in-depth into how the preset system works, which enables full customization of generators.
 
-### [Interpretation of JSON Schema draft 7](./interpretation_of_JSON_Schema_draft_7.md)
-Explains how a JSON Schema draft 7 schema is interpreted to a data model.
+### [Interpretation of JSON Schema](./interpretation_of_JSON_Schema.md)
+Explains how a JSON Schema is interpreted to a data model.
 
 ### Languages
 Each language has its own limitations, corner cases, and features; thus, each language has separate documentation.

docs/input_processing.md

@@ -1,4 +1,4 @@
-# Interpretation of JSON Schema draft 7 to CommonModel
+# Interpretation of JSON Schema to CommonModel
 
 The library transforms JSON Schema from data validation rules to data definitions (`CommonModel`(s)). 
 

…interpretation_of_JSON_Schema_draft_7.md docs/interpretation_of_JSON_Schema.mddocs/interpretation_of_JSON_Schema_draft_7.md renamed to docs/interpretation_of_JSON_Schema.md docs/interpretation_of_JSON_Schema_draft_7.md renamed to docs/interpretation_of_JSON_Schema.md

@@ -25,20 +25,36 @@ TODO
 
 ## Generate models from AsyncAPI documents
 
+When providing an AsyncAPI document, the library iterates the entire document and generate models for all defined messages. If any other kind of iteration is wanted, feel free to create a [feature request](https://github.com/asyncapi/modelina/issues/new?assignees=&labels=enhancement&template=enhancement.md).
+
 There are two ways to generate models for an AsyncAPI document.
 
 - [Generate from a parsed AsyncAPI document](../examples/asyncapi-from-parser)
 - [Generate from a pure JS object](../examples/asyncapi-from-object)
 
 The library expects the `asyncapi` property for the document to be set in order to understand the input format.
 
+The message payloads, since it is a JSON Schema variant, is [interpreted as a such](./interpretation_of_JSON_Schema.md).
+
 ## Generate models from JSON Schema draft 7 documents
 
 There are one way to generate models from a JSON Schema draft 7 document.
 
 - [Generate from a pure JS object](../examples/json-schema-draft7-from-object)
 
-The library expects the `$schema` property for the document to be set in order to understand the input format. By default, if no other inputs are detected, it defaults to `JSON Schema draft 7`.
+The library expects the `$schema` property for the document to be set in order to understand the input format. By default, if no other inputs are detected, it defaults to `JSON Schema draft 7`. The process of interpreting a JSON Schema to a model can be read [here](./interpretation_of_JSON_Schema.md).
+
+## Generate models from Swagger 2.0 documents
+When providing an AsyncAPI document, Modelina iterates the entire document and generate models for all defined `body` parameters and responses. If any other kind of iteration is wanted, feel free to create a [feature request](https://github.com/asyncapi/modelina/issues/new?assignees=&labels=enhancement&template=enhancement.md).
+
+There are one way to generate models from a Swagger 2.0 document
+
+- [Generate from a pure JS object](../examples/swagger2.0-from-object)
+
+The Swagger input processor expects that the property `swagger` is defined in order to know it should be processed.
+
+The response payload and `body` parameters, since it is a JSON Schema variant, is [interpreted as a such](./interpretation_of_JSON_Schema.md).
+
 
 ## Generate Go models
 TODO 

docs/usage.md

@@ -6,6 +6,7 @@ This directory contains a series of self-contained examples that you can use as
 - [asyncapi-from-object](./asyncapi-from-object) - A basic example where an AsyncAPI JS object is used to generate models.
 - [asyncapi-from-parser](./asyncapi-from-parser) - A basic example where an AsyncAPI JS object from the [parser-js](https://github.com/asyncapi/parser-js) is used to generate models.
 - [json-schema-draft7-from-object](./json-schema-draft7-from-object) - A basic example where a JSON Schema draft 7 JS object is used to generate models.
+- [swagger2.0-from-object](./swagger2.0-from-object) - A basic example where a Swagger 2.0 JS object is used to generate models.
 - [java-generate-javax-constraint-annotation](./java-generate-javax-constraint-annotation) - A basic example that shows how Java data models having `javax.validation.constraints` annotations can be generated.
 - [java-generate-javadoc](./java-generate-javadoc) - A basic example of how to generate Java models including JavaDocs.
 - [custom-logging](./custom-logging) - A basic example where a custom logger is used.

examples/README.md

@@ -7,6 +7,7 @@ describe('Should be able to render TEMPLATE', () => {
   });
   test('and should log expected output to console', async () => {
     await generate();
+    //Generate is called 2x, so even though we expect 1 model, we double it
     expect(spy.mock.calls.length).toEqual(2);
     expect(spy.mock.calls[1]).toMatchSnapshot();
   });

examples/TEMPLATE/index.spec.ts

@@ -6,6 +6,7 @@ describe('Should be able to process a pure AsyncAPI object', () => {
   });
   test('and should log expected output to console', async () => {
     await generate();
+    //Generate is called 2x, so even though we expect 1 model, we double it
     expect(spy.mock.calls.length).toEqual(2);
     expect(spy.mock.calls[1]).toMatchSnapshot();
   });

examples/asyncapi-from-object/index.spec.ts

@@ -7,6 +7,7 @@ describe('Should be able to process AsyncAPI object from parser', () => {
   });
   test('and should log expected output to console', async () => {
     await generate();
+    //Generate is called 2x, so even though we expect 1 model, we double it
     expect(spy.mock.calls.length).toEqual(2);
     expect(spy.mock.calls[1]).toMatchSnapshot();
   });

examples/asyncapi-from-parser/index.spec.ts

@@ -7,6 +7,7 @@ describe('Should be able to process JSON Schema draft 7 object', () => {
   });
   test('and should log expected output to console', async () => {
     await generate();
+    //Generate is called 2x, so even though we expect 1 model, we double it
     expect(spy.mock.calls.length).toEqual(2);
     expect(spy.mock.calls[1]).toMatchSnapshot();
   });