You can use the code generator from the command line. It is available for download in the GitHub Release
section of this repository. To run it, it requires dotnet to be installed.
Example:
dotnet Dangl.AVACloudClientGenerator.dll -l <Language> -o <OutputFolder>
| Parameter | Description |
|---|---|
| -o | Path where to save the generated client to |
| -l | Language of the client. See below for available options |
| -u | Optional. Url of the Swagger definitions document. Defaults to 'https://avacloud-api.dangl-it.com/swagger/swagger.json' |
| --help | Display options |
Currently, the converter supports the following values for the language argument:
| Parameter | Language |
|---|---|
Java |
Produces a Java 8 compatible client |
TypeScriptNode |
Produces a TypeScript / JavaScript package compatible with the NodeJs runtime and Browser environments |
JavaScript |
Produces a JavaScript package to be used in browsers |
Php |
Produces a Php client |
Python |
Produces a Python client |
Dart |
Produces a Dart client |
By executing the following command in the project root, all available clients are generated:
powershell ./build.ps1 GenerateClients
You can optionally pass the CustomSwaggerDefinitionUrl, e.g.:
powershell ./build.ps1 GenerateClients -CustomSwaggerDefinitionUrl https://avacloud-api-dev.dangl-it.com/swagger/swagger.json
The Java client is available for download in this repositories Releases section on GitHub.
The TypeScript / JavaScript client for NodeJs is published as npm package @dangl/avacloud-client-node.
It is generated and published by running the following build script:
powershell ./build.ps1 GenerateAndPublishTypeScriptNpmClient
Use the optional NodePublishVersionOverride parameter to supply a custom version instead of syncing with the AVACloud version.
The JavaScript client for Browsers is published as npm package @dangl/avacloud-client-javascript
It is generated and published by running the following build script:
powershell ./build.ps1 GenerateAndPublishJavaScriptNpmClient
Use the optional NodePublishVersionOverride parameter to supply a custom version instead of syncing with the AVACloud version.
The PHP client is available for download in this repositories Releases section on GitHub.
Additionally, it's published on Packagist to be directly consumed via composer.json: https://packagist.org/packages/dangl/avacloud
The package is published by running this command:
powershell ./build.ps1 GenerateAndPublishPhpClient
The Python client is available for download in this repositories Releases section on GitHub and on https://github.com/Dangl-IT/avacloud-client-python.
Internally, it uses the Swagger Generator to generate the client API for Dangl.AVACloud.