3.9 KiB
Codegen
The RESO Commander CLI contains code generation for the following items:
- Generating RESO Data Dictionary Acceptance Tests
- Generating RESO Web API Reference Server Data Models
- Generating RESO Data Dictionary Reference Metadata
- Generating RESO Data Dictionary 1.7 Reference DDL
- Converting OData XML Metadata to Open API 3 Format
Generating RESO Data Dictionary Acceptance Tests
The RESO Commander can be used to generate Data Dictionary acceptance tests from the currently approved Data Dictionary Spreadsheet.
The Commander project's copy of the sheet needs to be updated with a copy of the DD Google Sheet prior to generating reference metadata.
$ java -jar path/to/web-api-commander.jar --generateDDAcceptanceTests
New Cucumber BDD acceptance tests will be generated and placed in a timestamped directory relative to your current path.
To update the current tests, copy the newly generated ones into the Data Dictionary BDD .features directory, run the ./gradlew build task, and if everything works as expected, commit the newly generated tests.
Generating RESO Data Dictionary Reference Metadata
In addition to generating DD acceptance tests, the RESO Commander can generate reference metadata based on the current reference Data Dictionary Spreadsheet.
$ java -jar path/to/web-api-commander.jar --generateReferenceEDMX --inputFile=src/main/resources/RESODataDictionary-1.7.xlsx
In order to update the Commander's version of the reference metadata, update the local copy of the DD Google Sheet prior to generating metadata, replace the local copy, and try running automated acceptance tests with ./gradlew build.
Generating RESO Data Dictionary 1.7 Reference DDL
There is a command that can generate reference DDL for creating SQL databases using either key or key numeric values.
String Keys
Issuing the following will print DDL in the console using String keys as the primary key:
$ java -jar path/to/web-api-commander.jar --generateReferenceDDL
This means that linked lookups will also use string keys since they'll be linked by a related table that uses string keys.
There is a variable string key size in the DDLProcessor (currently 64 characters in length).
Numeric keys are still present in this case, they're just not the primary key.
Numeric Keys
Issuing the following will print DDL in the console using Numeric keys as the primary key:
$ java -jar path/to/web-api-commander.jar --generateReferenceDDL --useKeyNumeric
In this case, BIGINT values will be used for all related lookup values.
DDL TODO
The following items need to be added to the DDL generator still:
- Foreign Key relationships.
- Creation of Lookup resource.
Converting OData XML Metadata to Open API 3 Format
In order to generate an Open API 3 Spec from the reference metadata, run the following command from the root of the odata-openapi3 directory:
$ odata-openapi3 --host 'api.reso.org' --scheme 'https' --basePath '' ../src/main/resources/RESODataDictionary-1.7.xml
You will need to issue an npm install command from the odata-openapi3 directory in order for the packages to be available.
See documentation regarding running the nodejs-based tools in the odata-openapi README.md.