This program generates a fully-fledged Excel-based Robot Framework Datadriver test case from an OpenAPI file.
- Supports OpenAPI V3 YAML and JSON input file formats. V2 file format support can be achieved through library reconfiguration.
- The program will read a valid OpenAPI file and then tries to generate the following output files for you:
- A Robot Framework test file, containing all tests that are associated with this OpenAPI file
- A generic RF 'include' file
- An Excel file which will be used by the Robot Framework test as input data
- Optional: generate Jira / XRay Test / Test Exceution tickets and associate them with the Robot Framework test
- All input data is template-based, meaning that you can apply simple modifications to Jira / Robot template files which will then represent the foundation for the future Excel/Robot test file
- All resulting files will no longer be dependent on the initial OpenAPI input file. The idea for this program is that it will generate the majority of required code for you and that you customize that code later on for your needs.
- For each API call, the program will try to determine the supported optional and required parameters for the request body:
- Red fields indicate a mandatory parameter
- Green fields indicate optional parameters
- Grey fields indicate fields which are not supported for this API call
- Beige fields indicate test parameters such as test name, tags etc
- You can easily customize these values in the program.
- If a parameter has been assigned with an enum list of valid values, the program will add these values as a pre-populated dropdown to the Excel list. Users can select a value from that list (but are still able to overwrite that value)
- By default, the program will only highlight the optional/mandatory parameter fields (but will not populate them with any content). You can override this setting and tell the program to pre-populate the parameters with example data straight from your OpenAPI file.
- Expected HTTP response codes are extracted from the OpenAPI file and added to the Excel sheet as default value
- All OpenAPI input parameters in the Excel file are alphabetically sorted for a better user convenience when it comes to populating the sheet with data.
- The program will try to create a fully-fledged Robot Framework test case for you.
- Each API call will be tailored to the respective API service method, meaning that
- a JSON request body will only be sent to the API if the respective API service method supports it
- the JSON request body will only contain parameters that belong to this specific API service method
- If a service method requires parameters to be sent as part of the API's URL, the program will generate these URLs for you.
- Each API call will be tailored to the respective API service method, meaning that
- Some minor adjustments to the Robot file(s) may still be necessary (e.g. initial API setup, nested data structures) - see known issues.