26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
# Introduction
|
|
This application is intended to automate the API generation process
|
|
|
|
# Getting Started
|
|
Before running the application you have to install docker and edit the appsettings.json file to make
|
|
it fit your execution environment and needs.
|
|
|
|
# Update appsettings.json
|
|
You'll basically just need to modify the values below :
|
|
- Invite : Shell used to launch some commands
|
|
- LocalRoot : Location of api folder on your computer
|
|
- SpecIdentifier : Default spec to use for generation when no argument is passed to the application
|
|
|
|
# Run the application
|
|
Now that you updated appsettings.json, here are the arguments you could pass to the application :
|
|
- --name : The name of the specifications you want to use for generation (e.g : If you wanna use mySpec.yaml, the value will be mySpec)
|
|
- --models-only : Only schemas will be generated
|
|
- --api-only : Only controllers will be generated
|
|
- --client-only : Only client-side code will be generated
|
|
- --safe-publish : Check up the existing versions of packages and only publish those that doesn't exists on the repository
|
|
- --force-publish : Publish the result of the generation and overrides existing versions
|
|
- --export-puml : Export the dependency graph as Plant UML file
|
|
|
|
# Here are you files, sir
|
|
Once the generation process is done, you'll find the generated files in <root>/api/generated/<spec>/
|