The OpenAPI specification for interacting with REST APIs that Trellix Intelligent Sandbox (former: ATD) offers.
- Navigate to: OpenAPI Generator installation
- Choose the CLI client that suits your need/integrates with your platform better. (Recommended to use v5.0.1+) For more info please visit: https://openapi-generator.tech
- The OpenAPI Generator supports many different integrations and use cases, including (but not limited to):
- Maven Plugin
- Gradle Plugin
- Bazel Plugin
- SBT Plugin
- Cake Plugin
- CLI via Homebrew
- CLI via Docker
- CLI via npm
- Generator SaaS
For details, see Workflow Integrations
NOTE:
In some cases the cli generator might be named as openapi-generator-cli
instead of openapi-generator
, please be cautious.
- Run the following command and make sure you are running version 5.0+. Find the latest version here
openapi-generator version
- For listing out the available languages you can use:
openapi-generator list
Alternatively, you can visit: List of client generators for list of supported client SDKs. - For generating the client in the language of your choice, run the following:
openapi-generator generate -i input_file_name.yaml -g a_language_name_from_list -o /path/to/output_folder
NOTE:
1. If during execution you encounter an error saying "any module/model name" not found, kindly generate the client using the following global property:
openapi-generator generate -i file_name.yaml -g a_language_name_from_list -o /path/to/output_folder --global-property skipFormModel=false
In order to import the OpenAPI file in postman, please refer to : working with openAPI
For Code of conduct and contribution guidelines please refer to CODE_OF_CONDUCT and CONTRIBUTING respectively.