https://github.com/symbol/symbol-openapi-generator

Generates and deploys OpenAPI generated client libraries for Symbol SDKs
https://github.com/symbol/symbol-openapi-generator

api generator nem open-api swagger symbol

Last synced: 16 days ago
JSON representation

Generates and deploys OpenAPI generated client libraries for Symbol SDKs

• Host: GitHub
• URL: https://github.com/symbol/symbol-openapi-generator
• Owner: symbol
• License: apache-2.0
• Created: 2019-10-25T10:42:53.000Z (about 5 years ago)
• Default Branch: dev
• Last Pushed: 2021-11-12T12:07:55.000Z (about 3 years ago)
• Last Synced: 2024-10-22T14:34:24.319Z (25 days ago)
• Topics: api, generator, nem, open-api, swagger, symbol
• Language: Shell
• Homepage:
• Size: 120 MB
• Stars: 3
• Watchers: 19
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# symbol-openapi-generator

[![Build Status](https://travis-ci.com/nemtech/symbol-openapi-generator.svg?branch=main)](https://travis-ci.com/nemtech/symbol-openapi-generator)

Project in charge of generating the API client libraries used by the Symbol SDKs.

The ``generate`` script creates different flavours of clients according to the [current OpenAPI specification](https://github.com/nemtech/symbol-openapi).

## Supported languages

| Language   | Template         | 

|------------|------------------|

| Typescript | typescript-node  |

|            | typescript-fetch |

| Java       | vertx            |

|            | jersey2          |

|            | okhttp-gson      |

| Python     | python           |

See possible options for languages and flavours [here](https://openapi-generator.tech/docs/generators/).

## Requirements

* NPM 8

* Java 8

## Usage

Once you have installed the dependencies, run:

~~~~

npm install @openapitools/[email protected] [email protected]  -g

bash download-and-patch.sh

bash generate.sh [template]

~~~~

The script will:

1. Download the released openapi3.yml from [symbol-openapi](https://github.com/nemtech/symbol-openapi/releases) of the current version (version.txt).

2. Create a patched version of the open api specification (see notes below).

3. Generate one library per language / template / framework.

4. Build each library.

5. Build and install libraries using PyPI, NPM and Gradle.

## Notes for SDKs developers

* Running the generator is not required to build the SDKs. The generated libs are published into a central repository (e.g. maven, npm).  The SDKs depend on those libraries like any other third party dependency.

* The generated lib version (artifact version) should be consistent with the OpenAPI spec. For instance, if the current version is 0.7.19,  the generated libraries should have version 0.7.19. If the descriptor changes and the version is updated, the libraries should be upgraded, regenerated, and deployed.

* The generator uses a patched version of the descriptor due to the AnyOf  [bug](https://github.com/OpenAPITools/openapi-generator/issues/634).

* There is a small tune in the java generation that uses BigInteger attributes instead of String when a field is a String number. The tune is by using ``typeMappings =  ["x-number-string": "java.math.BigInteger"]`` and by replacing the string type to ``x-number-string`` in the ``openapi3-any-of-patch.yaml``.

* ⚠️Generated code must not be changed not committed!!! Note that the ``build`` folder is gitignored. If there is something wrong with the generated code, you need to [customize the generator](https://openapi-generator.tech/docs/customization.html).

## License

Copyright (c) 2020-present NEM

Licensed under the [Apache License 2.0](LICENSE)