This is an OpenAPI generator for Dart (v2 and above) which allows generation of Symbol API client libraries for symbol SDK Dart (symbol-sdk-dart) automatically given a Symbol OpenAPI specification (symbol-openapi).
An OpenAPI Generator CLI version 4.3.0 (or above) for your Operating System is required to generate the client libraries. The code generation script uses Homebrew by default and it will install the openapi-generator-cli when it has not been installed.
If you want to install and use the OpenAPI generator without using Homebrew, then you can disable the line inside the code generation script that checks and installs it.
Run the script to download and patch the Symbol OpenAPI specification file:
./download-and-patch.sh
And then run the code generation script:
./generate.sh
Please note that the generator also generates .gitignore, a README, Dart metadata (pubspec), Travis and other configuration files which will overwrite any existing files with the same name.
The OpenAPI generator accepts custom configuration available for Dart from the file openapi-config.yaml. Please refer to the following page for a complete list of config options: dart or dart-dio (depends on your preference).
This project is updated for Symbol OpenAPI specification version 0.8.9.
- This project's version should be consistent with that of the Symbol OpenAPI specification (as specified inside
openapi3.yaml). - Whenever there is a new version available for the Symbol OpenAPI specification, this project should be upgraded, regenerated and published to Dart packages repository.
- The generator currently uses a patched version of the specification (
openapi3-dart.yaml) due to an ongoing bug of theanyOfwhich also affects the Dart generator. We will use the standard specification once theanyOfissue has been fixed. - Due to an open issue to the OpenAPI generator for Dart version 2 (dart2 template issue), you may want to use a custom template provided inside the
dart2-templatedirectory instead of the default one. You can change the generator script to use this custom template when generating the code.
- Complete the whole dev process.
- Add Travis integration.
- Publish to Dart packages repository.
Copyright (c) 2020
Licensed under the Apache License 2.0
THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS, REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL CLAIM, DAMAGES OR OTHER LIABILITY (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN ACTION OF CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.