new_heim_application
Generate application scaffolding from OpenAPI 3.0.1 specifications in Rust or CSharp. Specify paths, name, language, and version to create a structured project folder with predefined templates.
Instructions
Runs 'heim new' command on your local computer to create application schafholding from an OpenAPI 3.0.1 specification.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
basePath | No | The base path added bafore the path in the OpenAPI schema. Defaults to not adding a base path. | / |
language | Yes | The programming language you want to use for creating an application from an OpenAPI specification. Currently Rust and CSharp are supported. | |
name | Yes | The name of the application. This will be used to name the application folder and set the name in the application.toml file. | |
openApiPath | Yes | Absolute windows path to OpenAPI file. The schema requires operationId and a full list of what Heim supports of the OpenAPI schema can be found here: https://cloud.heim.dev/heim/docs/templates/openapi/#openapi-root-object | |
overwrite | No | Should the new application overwrite an existing folder if it already exists? Defaults to `false`. | |
path | Yes | Absolute windows path to the folder where the project should be created. The created project will be under this path with a folder name called 'name'. The code to modify will be under <PATH>/<NAME>/src/ and the heim folder within shouldn't be modified. | |
version | No | The version number it will set for the application in SemVer format. Defaults to `0.1.0`. | 0.1.0 |