зеркало из https://github.com/Azure/autorest.git
Timothee Guerin
GitHub
Родитель
3687a5ac8f
Коммит
7bc20465c3
|
|
@ -0,0 +1,11 @@
|
|||
{
|
||||
"changes": [
|
||||
{
|
||||
"packageName": "@autorest/configuration",
|
||||
"comment": "",
|
||||
"type": "none"
|
||||
}
|
||||
],
|
||||
"packageName": "@autorest/configuration",
|
||||
"email": "tiguerin@microsoft.com"
|
||||
}
|
||||
|
|
@ -1,5 +1,41 @@
|
|||
# <img align="center" src="../images/logo.png"> Index of AutoRest Flags
|
||||
|
||||
## Output Verbosity
|
||||
|
||||
| Option | Description |
|
||||
| ----------- | ------------------------------- |
|
||||
| `--verbose` | show verbose output information |
|
||||
| `--debug` | show internal debug information |
|
||||
| `--quiet` | suppress output |
|
||||
|
||||
## Managing the installed/used AutoRest version
|
||||
|
||||
| Option | Description |
|
||||
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--list-installed` | show all installed versions of AutoRest tools |
|
||||
| `--list-available=nn` | lists the last nn releases available from github (defaults to 10) |
|
||||
| `--version=version` | uses version of AutoRest (installing if necessary.) |
|
||||
| `--reset` | remove all installed versions of AutoRest tools and install the latest (override with --version) |
|
||||
| `--use` | Specify an extension to load and use. Format: `--use=<packagename>[@<version>]` (e.g. `--use=@autorest/modelerfour@~4.19.0`) |
|
||||
|
||||
## Autorest flags
|
||||
|
||||
Those are flags that affect autorest only
|
||||
|
||||
| Flag | Description |
|
||||
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--output-converted-oai3` | If enabled and the input-files are `swager 2.0` this will output the resulting OpenAPI3.0 converted files to the `output-folder` |
|
||||
| `--memory` | Configure the max memory allowed to the autorest core process. Usage: `--memory=8g` or `--memory=8192m` (to set to 8gb) |
|
||||
|
||||
#### Validation
|
||||
|
||||
| Option | Description |
|
||||
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--azure-validator` | If set, runs the Azure specific validator plugin. |
|
||||
| `--openapi-type=arm│default│data-plane` | Indicates the type of configuration file being passed to the `azure-validator` so that it can run the appropriate class of validation rules accordingly. |
|
||||
| `--model-validator` | If set, validates the provided OpenAPI definition(s) against provided `examples`. |
|
||||
| `--skip-semantics-validation` | Disable the semantic validator plugin. |
|
||||
|
||||
## Shared Flags
|
||||
|
||||
| Flag | Description | Python | .NET | Java | TS | Go |
|
||||
|
|
@ -16,6 +52,7 @@
|
|||
| `--azure-arm` | generates control plane (Azure Resource Manager) code. Use this if you're generate SDKs for people to manage their Azure resources. See our [mgmt plane section][mgmt_plane_section] for more info. Defaults to `false`. | x | x | x | x | Uses flag `--openapi-type=arm` to specify |
|
||||
| `--head-as-boolean` | With this flag, HEAD calls to non-existent resources (404) will not raise an error. Instead, if the resource exists, we return `true`, else `false`. Forced to be `true` if `--azure-arm` is set, otherwise defaults to `false`. | x | x | | | Go default is always `false`. |
|
||||
| `--title=NAME` | Override the service client's name listed in the swagger under `title`. | x | x | x | x | x |
|
||||
| `--override-client-name=NAME` | Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files | x | x | x | x | x |
|
||||
| `--description=DESCRIPTION` | Override the service client's description listed in the swagger under the top level `description`. | x | x | x | x | x |
|
||||
| `--client-side-validation` | Whether you want the SDK to perform validation on inputs and outputs, based on swagger information. Recommended to be `false` for track 2 code, since we want the network to validate instead. Defaults to `false`. | x | x | calls it `--client-side-validations` | | x |
|
||||
| `--package-name=NAME` | The name of your package. This is the name your package will be published under. | x | | | x |
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
# Content Moved
|
||||
|
||||
See [command-line-interface](./command-line-interface.md)
|
||||
|
|
@ -10,112 +10,39 @@ The AutoRest command line has been vastly simplified, with the preference to mov
|
|||
|
||||
### Configuration file
|
||||
|
||||
AutoRest will use a [configuration file](./configuration.md) to control the code generation process. By default, AutoRest will look for a file called `readme.md` or it can be passed on the command line.
|
||||
AutoRest will use a [configuration file](./configuration.md) to control the code generation process. By default, AutoRest will look for a file called `readme.md` or it can be passed on the command line.
|
||||
|
||||
This is the preferred method, instead of passing all the information on the command line.
|
||||
This is the preferred method, instead of passing all the information on the command line.
|
||||
|
||||
If you prefer to name your configuration file something else, you can supply the filename on the command line:
|
||||
|
||||
``` bash
|
||||
autorest my_config.md
|
||||
```bash
|
||||
autorest my_config.md
|
||||
```
|
||||
|
||||
#### Passing additional options on the command line.
|
||||
|
||||
It is possible to override settings from the configuration file on the command line by prefacing the value with double dash (`--`) and setting the value with an equals sign (`=`). Ie:
|
||||
|
||||
``` bash
|
||||
```bash
|
||||
autorest --input-file=myfile.json --output-folder=./generated/code/ --namespace=foo.bar
|
||||
```
|
||||
|
||||
### Common Command-line Options
|
||||
### Common Command-line Options
|
||||
|
||||
#### Output Verbosity
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
|`--verbose`|show verbose output information|
|
||||
|`--debug`|show internal debug information|
|
||||
|`--quiet`|suppress output|
|
||||
|
||||
#### Managing the installed/used AutoRest version
|
||||
|
||||
|Option | Description |
|
||||
|------------------|-------------|
|
||||
|`--list-installed`|show all installed versions of AutoRest tools|
|
||||
|`--list-available=nn`|lists the last nn releases available from github (defaults to 10)|
|
||||
|`--version=version`|uses version of AutoRest (installing if necessary.)<br>For version you can use a version label (see --list-available) or<br> `latest` - get latest nightly build<br> `latest-release` - get latest release version|
|
||||
|`--reset`|remove all installed versions of AutoRest tools and install the latest (override with --version)|
|
||||
|`--runtime-id=id`|overrides the platform detection for the dotnet runtime (special case). Refer to the <a href="https://docs.microsoft.com/en-us/dotnet/articles/core/rid-catalog">Runtime Identifier (RID) catalog</a> for more details.|
|
||||
|
||||
#### Commonly used Settings
|
||||
|
||||
|Option | Description |
|
||||
|------------------|-------------|
|
||||
|`--input-file=FILENAME`|Adds the given file to the list of input files for generation process|
|
||||
|`--output-folder=DIRECTORY`|The location for generated files. If not specified, uses `./Generated` as the default|
|
||||
|`--namespace=NAMESPACE`|sets the namespace to use for the generated code|
|
||||
|`--license-header\|licence-header=HEADER`| Text to include as a header comment in generated files. Use NONE to suppress the default header.|
|
||||
|`--add-credentials`|If specified, the generated client includes a ServiceClientCredentials property and constructor parameter. Authentication behaviors are implemented by extending the ServiceClientCredentials type.|
|
||||
|`--package-name=PACKAGENAME`|Name of the package (Ruby, Python)|
|
||||
|`--package-version=VERSION`|Version of the package (Ruby, Python)|
|
||||
|`--sync-methods=all\|essential\|none`|Specifies mode for generating sync wrappers. Supported value are <br> `essential` - generates only one sync returning body or header (default) <br> `all` - generates one sync method for each async method<br> `none` - does not generate any sync methods|
|
||||
|`--payload-flattening-threshold=NUMBER`|The maximum number of properties in the request body. If the number of properties in the request body is less than or equal to this value, these properties will be represented as method arguments|
|
||||
|`--override-client-name=NAME`|Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files|
|
||||
|`--use-internal-constructors`|Indicates whether ctor needs to be generated with `internal` protection level.|
|
||||
|`--use-datetimeoffset`|Indicates whether to use DateTimeOffset instead of DateTime to model date-time types|
|
||||
|`--models-name=NAME`|Name to use for the generated client models namespace and folder name. By default, uses the value of 'Models'. This is not currently supported by all code generators.|
|
||||
|`--output-file=FILENAME`|If set, will cause generated code to be output to a single file. Not supported by all code generators.|
|
||||
|`--message-format=regular\|json`|Specifies the format, messages will be printed as. JSON format is easier to process programmatically.|
|
||||
See [flags](https://github.com/azure/autorest/blob/main/docs/generate/flags.md)
|
||||
|
||||
#### Authentication
|
||||
|
||||
AutoRest supports generating from private GitHub repositories.
|
||||
There are multiple options:
|
||||
|
||||
1) **Using the `token` query parameter**: Pass the `token` query parameter you get when clicking "Raw" on a file of a private repo, i.e. `https://github.com/<path-on-some-private-repo>/readme.md?token=<token>`.
|
||||
When such a URI is passed to AutoRest, it will automatically reuse that token for subsequent requests (e.g. querying referenced OpenAPI definitions).
|
||||
This is a quick and easy solution if you manually want to run AutoRest against private bits from time to time.
|
||||
2) **Using OAuth**: GitHub allows generating OAuth tokens under `Settings -> Personal access tokens`.
|
||||
Create one with `repo` scope.
|
||||
It can be passed to AutoRest using `--github-auth-token=<token>` or by setting the environment variable `GITHUB_AUTH_TOKEN`.
|
||||
This is the way to go for all scripts and automation.
|
||||
Needless to say, *do not put this token* into scripts directly, use Azure KeyVault or similar.
|
||||
**Note**: If the repository is in an organization it might require the Github Token to be given explicit permission to that organization.(Next to the token Enable SSO > Click Authorize for the relevant organization)
|
||||
|
||||
#### Validation
|
||||
|
||||
|Option | Description |
|
||||
|------------------|-------------|
|
||||
|`--azure-validator`|If set, runs the Azure specific validator plugin.|
|
||||
|`--openapi-type=arm│default│data-plane`|Indicates the type of configuration file being passed to the `azure-validator` so that it can run the appropriate class of validation rules accordingly.|
|
||||
|`--model-validator` (***soon***)|If set, validates the provided OpenAPI definition(s) against provided `examples`.|
|
||||
|`--semantic-validator` (***soon***)|If set, semantically verifies the provided OpenAPI definition(s), e.g. checks that a parameter's specified `default` value matches the parameter's declared type.|
|
||||
|
||||
Example:
|
||||
Run `autorest --azure-validator --input-file=<path-to-spec> --message-format=json --openapi-type=arm` to get the validation messages considering ARM guidelines in JSON format.
|
||||
|
||||
Also, see [Samples/2a-validation](../../Samples/openapi-v2/2a-validation) for an example of validation using a configuration file.
|
||||
|
||||
#### Selecting the Language with which to generate code
|
||||
|
||||
|Option | Description |
|
||||
|------------------|-------------|
|
||||
|`--csharp`|Runs the C# code generator|
|
||||
|`--nodejs`|Runs the nodejs javascript code generator|
|
||||
|`--python`|Runs the python code generator|
|
||||
|`--java`|Runs the java code generator|
|
||||
|`--ruby`|Runs the ruby code generator|
|
||||
|`--go`|Runs the go code generator|
|
||||
|`--typescript`|Runs the typescript code generator|
|
||||
|`--azureresourceschema`|Runs the AzureResourceSchema|
|
||||
| | |
|
||||
|`--azure-arm`|Uses the `Azure` version of the specified code generator|
|
||||
|
||||
You may generate one or more languages in a given invocation, ie:
|
||||
|
||||
`autorest --csharp --python --ruby`
|
||||
|
||||
To set a language-specific setting, prefix the setting with the language, ie:
|
||||
|
||||
`autorest --csharp.namespace=Foo.Bar `
|
||||
1. **Using the `token` query parameter**: Pass the `token` query parameter you get when clicking "Raw" on a file of a private repo, i.e. `https://github.com/<path-on-some-private-repo>/readme.md?token=<token>`.
|
||||
When such a URI is passed to AutoRest, it will automatically reuse that token for subsequent requests (e.g. querying referenced OpenAPI definitions).
|
||||
This is a quick and easy solution if you manually want to run AutoRest against private bits from time to time.
|
||||
2. **Using OAuth**: GitHub allows generating OAuth tokens under `Settings -> Personal access tokens`.
|
||||
Create one with `repo` scope.
|
||||
It can be passed to AutoRest using `--github-auth-token=<token>` or by setting the environment variable `GITHUB_AUTH_TOKEN`.
|
||||
This is the way to go for all scripts and automation.
|
||||
Needless to say, _do not put this token_ into scripts directly, use Azure KeyVault or similar.
|
||||
**Note**: If the repository is in an organization it might require the Github Token to be given explicit permission to that organization.(Next to the token Enable SSO > Click Authorize for the relevant organization)
|
||||
|
|
|
|||
|
|
@ -76,6 +76,12 @@ help-content: # type: Help as defined in autorest-core/help.ts
|
|||
- key: output-converted-oai3
|
||||
type: string
|
||||
description: If enabled and the input-files are `swager 2.0` this will output the resulting OpenAPI3.0 converted files to the `output-folder`
|
||||
- key: title
|
||||
type: string
|
||||
description: Override the service client's name listed in the swagger under `title`.
|
||||
- key: override-client-name
|
||||
type: string
|
||||
description: Name to use for the generated client type. By default, uses the value of the 'Title' field from the input files
|
||||
|
||||
_autorest-core-1:
|
||||
categoryFriendlyName: Core Functionality
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче