Skip to content

zihzhan-msft/autorest.java

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

850 Commits

.github

.github

 
 

androidgen

androidgen

 
 

azure-tests

azure-tests

 
 

customization-base

customization-base

 
 

customization-tests

customization-tests

 
 

docs

docs

 
 

eng/pipelines

eng/pipelines

 
 

extension-base

extension-base

 
 

fluent-tests

fluent-tests

 
 

fluentgen

fluentgen

 
 

fluentnamer

fluentnamer

 
 

javagen

javagen

 
 

postprocessor

postprocessor

 
 

preprocessor

preprocessor

 
 

protocol-resilience-test

protocol-resilience-test

 
 

protocol-tests

protocol-tests

 
 

vanilla-tests

vanilla-tests

 
 

.gitignore

.gitignore

 
 

.npmignore

.npmignore

 
 

bodycomplex.md

bodycomplex.md

 
 

generate

generate

 
 

generate-android.bat

generate-android.bat

 
 

generate.bat

generate.bat

 
 

package.json

package.json

 
 

pom.xml

pom.xml

 
 

readme.md

readme.md

 
 

Repository files navigation

Overview

This is the next gen (v4) of AutoRest Java generator. It's built on AutoRest v3, written in Java, and supports OpenAPI3. It generates clients that work with com.azure:azure-core.

Prerequisites

You need to have the following installed on your machine:

  • Node.JS v10.x - v13.x
  • Java 8+
  • Maven 3.x

You need to have autorest installed through NPM:

npm install -g autorest

Usage

To use the latest released preview(https://github.com/Azure/autorest.java/releases), run

autorest --java
    --use:@autorest/java@4.0.x
    --input-file:path/to/specs.json
    --output-folder:where/to/generate/java/files
    --namespace:specified.java.package

The first time running it will take a little longer to download and install all the components.

To build from source code, clone this repo and checkout to main branch. Make sure all prerequisites are met, and run

mvn package -P local

This will build a file javagen-jar-with-dependencies.jar under javagen module, a preprocess-jar-with-dependencies.jar under preprocessor module, a fluentgen-jar-with-dependencies.jar under fluentgen module, and a fluentnamer-jar-with-dependencies.jar under fluentnamer module.

And then run AutoRest

autorest --java
    --use:where/this/repo/is/cloned/autorest.java
    --input-file:path/to/specs.json
    --output-folder:where/to/generate/java/files
    --namespace:specified.java.package

Java files will be generated under where/to/generate/java/files/src/main/java/specified/java/package.

To debug, add --java.debugger to the argument list. The JVM will suspend at the beginning of the execution. Then attach a remote debugger in your IDE to localhost:5005. Make sure you detach the debugger before killing the AutoRest process. Otherwise it will fail to shutdown the JVM and leave it orphaned. (which can be killed in the Task Manager)

Settings

Settings can be provided on the command line through --name:value or in a README file through name: value. The list of settings for AutoRest in general can be found at https://github.com/Azure/autorest/blob/main/docs/user/command-line-interface.md. The list of settings for AutoRest.Java specifically are listed below:

Option   Description
--enable-xml Generates models and clients that can be sent in XML over the wire. Default is false
--client-side-validations Generate validations for required parameters and required model properties. Default is false.
--generate-client-as-impl Append "Impl" to the names of service clients and method groups and place them in the implementation sub-package. Default is false.
--generate-client-interfaces Implies --generate-client-as-impl and generates interfaces for all the "Impl"s. Default is false.
--generate-sync-async-clients Implies --generate-client-as-impl and generates sync and async convenience layer clients for all the "Impl"s. Default is false.
--implementation-subpackage=STRING The sub-package that the Service client and Method Group client implementation classes will be put into. Default is implementation.
--models-subpackage=STRING The sub-package that Enums, Exceptions, and Model types will be put into. Default is models.
--add-context-parameter Indicates whether the com.azure.core.util.Context parameter should be included in generated proxy methods. Default is false.
--context-client-method-parameter Implies --add-context-parameter and indicates whether the com.azure.core.util.Context parameter should also be included in generated client methods. Default is false.
--sync-methods=all|essential|none Specifies mode for generating sync wrappers. Supported value are
  essential - generates only one sync returning body or header (default)
  all - generates one sync method for each async method
  none - does not generate any sync methods
--required-parameter-client-methods Indicates whether client method overloads with only required parameters should be generated. Default is false.
--custom-types=COMMA,SEPARATED,STRINGS Specifies a list of files to put in the package specified in --custom-types-subpackage.
--custom-types-subpackage=STRING The sub-package that the custom types should be generated in. The types that custom types reference, or inherit from will also be automatically moved to this sub-package. Recommended usage: You can set this value to models and set --models-subpackage=implementation.modelsto generate models to implementation.models by default and pick specific models to be public through --custom-types=.
--client-type-prefix=STRING The prefix that will be added to each generated client type.
--model-override-setter-from-superclass Indicates whether to override the superclass setter method in model. Default is false.
--service-interface-as-public Indicates whether to generate service interfaces as public. This resolves SecurityManager issues to prevent reflectively access non-public APIs. Default is false.
--require-x-ms-flattened-to-flatten Indicates whether x-ms-flattened is required to annotated a class with @JsonFlatten if the discriminator has . in its name. Default is false.
--client-flattened-annotation-target=TYPE,FIELD,NONE Indicates the target of @JsonFlatten annotation for x-ms-client-flatten. Default is TYPE. If value is FIELD, it implies require-x-ms-flattened-to-flatten=true.
--disable-client-builder Indicates whether to disable generating the ClientBuilder class. Default is false.
--skip-formatting Indicates whether to skip formatting Java file. This is for SDK that already contains a hand-written ClientBuilder class. Default is false.
--polling Configures how to generate long running operations. See Polling Configuration to see more details on how to use this flag.
--pass-discriminator-to-child-deserialization Indicates whether the discriminator property is passed to subclass deserialization. Default is false.

Additional settings for Fluent

fluent option enables the generator extension for Azure Management Libraries for Java.

Following settings only works when fluent option is specified.

Option Description
--fluent Enum. LITE for Fluent Lite; PREMIUM for Fluent Premium. Case insensitive. Default is PREMIUM if provided as other values.
--fluent-subpackage String. The sub-package that vanilla client and builder will be put into. Default is fluent.
--pom-file String. Name for Maven POM file. Default is pom.xml.
--package-version String. Version number for Maven artifact. Default is 1.0.0-beta.1.
--service-name String. Service name used in Manager class and other documentations. If not provided, service name is deduced from title configure (from swagger or readme).
--sdk-integration Boolean. Integrate to azure-sdk-for-java. Default is false. Provide output-folder as absolute path for best performance.
--generate-samples Boolean. Generate samples from x-ms-examples in swagger. Default is false.
--add-inner CSV. Treat as inner class (move to fluent.models namespace, append Inner to class name).
--remove-inner CSV. Exclude from inner classes.
--rename-model CSV. Rename classes. Each item is of pattern from:to.
--remove-model CSV. Remove classes.
--preserve-model CSV. Preserve classes from clean-up.
--name-for-ungrouped-operations String. Name for ungrouped operation group. Default to ResourceProviders for Lite.

fluent option will change the default value for some vanilla options. For example, generate-client-interfaces, context-client-method-parameter, required-parameter-client-methods, model-override-setter-from-superclass option is by default true.

The code formatter would require Java 11+ runtime.

Polling configuration

Polling configurations can be set through --polling setting globally or for each operation. The format is a key value map specified below:

polling:
  {operationId}:
    strategy: {strategy}
    intermediate-type: {intermediate-type}
    final-type: {final-type}
    poll-interval: {poll-interval}

With the fields specified below:

Field Type Required Description Example
operationId String true The operationId of the operation. For global polling configuration, use default. Case insensitive. Pets_put
strategy String false The invocation to construct a polling strategy. Use fully qualified class name if outside the implementation subpackage specified in namespace & implementation-subpackage. Use dynamic literals {httpPipeline}, {context}, {serializerAdapter}, {intermediate-type}, {final-type} if these components are required to construct the polling strategy. Default is com.azure.core.util.polling.ChainedPollingStrategy.createDefault({httpPipeline}, {context}). new com.azure.core.util.polling.OperationResourcePollingStrategy<>({httpPipeline}, {context})
intermediate-type String false The type of the polling intermediate type. Use fully qualified class name if outside the base package specified in namespace. Default is the return type specified on the operation in Swagger, or BinaryData if the operation returns void. PollResult,com.azure.core.util.BinaryData
final-type String false The type of the final result type. Use fully qualified class name if outside the base package specified in namespace. Default is the return type specified on the operation in Swagger, or BinaryData if the operation returns void. Pet,com.azure.core.util.BinaryData
poll-interval integer false The default interval in seconds to poll with (can be modified by users in PollerFlux and SyncPoller. Default is 1. 30

To use default settings globally, use --polling={}.

Protocol clients (low level clients)

You can generate the output as protocol clients, a.k.a., low level clients with --low-level-client flag. The models will not be generated and the methods in the clients will be generated as protocol methods. --low-leve-client should be used in conjunction with the following settings:

generate-client-interfaces: false
generate-client-as-impl: true
generate-sync-async-clients: true

The generated code has the following structure

- pom.xml
- /src/main/java
  |
  - module-info.java
  - /com/azure/<group>/<service>
    |
    - <Service>Builder.java
    - <Service>Client.java
    - <Service>AsyncClient.java
    - /implementation
      |
      - <Service>ClientImpl.java

and requires azure-core 1.19.0-beta.1 as a dependency.

Customizations

To set up customizations, create a Maven project with dependency:

<dependency>
  <groupId>com.azure.tools</groupId>
  <artifactId>azure-autorest-customization</artifactId>
  <version>1.0.0-beta.4</version>
</dependency>

Create a customization class extending from com.azure.autorest.customization.Customization and override the void customize(LibraryCustomization) method. You will have access to a LibraryCustomization class where you will be able to customize the generated Java code before it's written to the disk. Currently, the following customizations are supported:

Navigate through the packages and classes

There are 4 customization classes currently available, LibraryCustomization, PackageCustomization, ClassCustomization and JavadocCustomization. From a given LibraryCustomization, you can navigate through the packages and classes intuitively with the following methods:

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    /* code to customize on the package level */
    ClassCustomization foo = models.getClass("Foo");
    /* code to customize the Foo class */
    JavadocCustomization getBarJavadoc = foo.methodJavadoc("getBar");
    /* code to customize javadoc for getBar() method */
}

Change class modifier

A class Foo

public class Foo {
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.changeClassModifier(""); // change to package private
}

will generate

class Foo {
}

Change method modifier

A method getBar in the Foo class

public class Foo {
    private Bar bar;

    public Bar getBar() {
        return this.bar;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.changeMethodModifier("getBar", "private"); // change to private
}

will generate

public class Foo {
    private Bar bar;

    private Bar getBar() {
        return this.bar;
    }
}

Change method return type

You can change a method's return type, and pass a String formatter to transform the original return value statement. If the original return type is void, simply pass the full return value String expression in place of the String formatter; if the new return type is void, simply pass null.

A method getId in the Foo class

public class Foo {
    private String id;

    public String getId() {
        return this.id;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.changeMethodReturnType("getId", "UUID", "UUID.fromString(%s)"); // change to private
}

will generate

public class Foo {
    private String id;

    public UUID getId() {
        String returnValue = this.id;
        return UUID.fromString(returnValue);
    }
}

The UUID class will be automatically imported.

Add an annotation to a class

A class Foo

public class Foo {
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.addClassAnnotation("JsonFlatten");
}

will generate

@JsonFlatten
public class Foo {
}

The JsonFlatten class will be automatically imported.

Add an annotation to a method

A method getBar in the Foo class

public class Foo {
    private Bar bar;

    public Bar getBar() {
        return this.bar;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.addMethodAnnotation("getBar", "Deprecated");
}

will generate

public class Foo {
    private Bar bar;

    @Deprecated
    public Bar getBar() {
        return this.bar;
    }
}

The Deprecated class will be automatically imported.

Remove an annotation from a class

A class Foo

@Fluent
public class Foo {
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.removeClassAnnotation("Fluent");
}

will generate

public class Foo {
}

Refactor: Rename a class

A class Foo

public class Foo {
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    models.renameClass("Foo", "FooInfo");
}

will generate

class FooInfo {
}

All references of Foo will be modified to FooInfo. When a valid value is provided, this customization is guaranteed to not break the build.

Refactor: Rename a method

A method isSupportsUnicode in the Foo class

public class Foo {
    private boolean supportsUnicode;

    public boolean isSupportsUnicode() {
        return this.supportsUnicode;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.renameMethod("isSupportsUnicode", "supportsUnicode");
}

will generate

public class Foo {
    private boolean supportsUnicode;

    public boolean supportsUnicode() {
        return this.supportsUnicode;
    }
}

All references of isSupportsUnicode() will be modified to supportsUnicode(). When a valid value is provided, this customization is guaranteed to not break the build.

Refactor: Generate the getter and setter methods for a property

A property active in the Foo class

public class Foo {
    private boolean active;
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.generateGetterAndSetter("active");
}

will generate

public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

If the class already contains a getter or a setter method, the current method will be kept. This customization is guaranteed to not break the build.

Refactor: Rename a property and its corresponding getter and setter methods

A property whitelist in the Foo class

public class Foo {
    private List<String> whiteList;

    public List<String> getWhiteList() {
        return this.whiteList;
    }

    public Foo setWhiteList(List<String> whiteList) {
        this.whiteList = whiteList;
        return this;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.renameProperty("whiteList", "allowList");
}

will generate

public class Foo {
    private List<String> allowList;

    public List<String> getAllowList() {
        return this.allowList;
    }

    public Foo setAllowList(List<String> allowList) {
        this.allowList = allowList;
        return this;
    }
}

This customization is guaranteed to not break the build.

Refactor: Rename an enum member name

An enum member JPG in an enum class ImageFileType:

public enum ImageFileType {
    GIF("gif"),
    JPG("jpg"),
    TIFF("tiff"),
    PNG("png");
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization imageFileType = models.getClass("ImageFileType");
    foo.renameEnumMember("JPG", "JPEG");
}

will generate

public enum ImageFileType {
    GIF("gif"),
    JPEG("jpg"),
    TIFF("tiff"),
    PNG("png");
}

This customization is guaranteed to not break the build.

Javadoc: Set the description for a class / method

A class Foo

/** Class Foo. */
public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.classJavadoc().setDescription("A Foo object stored in Azure.")
    foo.methodJavadoc("setActive").setDescription("Set the active value.");
}

will generate

/**
 * A Foo object stored in Azure.
 */
public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    /**
     * Set the active value.
     */
    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

Javadoc: Set / remove a parameter's javadoc on a method

A class Foo

public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    /**
     * Set the active value.
     */
    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.methodJavadoc("setActive").setParam("active", "if the foo object is in active state");
}

will generate

public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    /**
     * Set the active value.
     *
     * @param active if the foo object is in active state
     */
    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

Javadoc: Set the return javadoc on a method

A Foo class

public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    /**
     * Set the active value.
     *
     * @param active if the foo object is in active state
     */
    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization models = customization.getPackage("com.azure.myservice.models");
    ClassCustomization foo = models.getClass("Foo");
    foo.methodJavadoc("setActive").setReturn("the current foo object");
}

will generate

public class Foo {
    private boolean active;

    public boolean isActive() {
        return this.active;
    }

    /**
     * Set the active value.
     *
     * @param active if the foo object is in active state
     * @return the current foo object
     */
    public Foo setActive(boolean active) {
        this.active = active;
        return this;
    }
}

Javadoc: Add / remove an exception's javadoc on a method

A FooClient class

public class FooClient {
    /**
     * Create a Foo object.
     *
     * @param foo the foo object to create in Azure
     * @return the response for creating the foo object
     */
    public CreateFooResponse createFoo(Foo foo) {
        /* REST call to create foo */
    }
}

with customization

@Override
public void customize(LibraryCustomization customization) {
    PackageCustomization root = customization.getPackage("com.azure.myservice");
    ClassCustomization fooClient = root.getClass("FooClient");
    fooClient.methodJavadoc("createFoo").addThrows("HttpResponseException", "An unsuccessful response is received");
}

will generate

public class FooClient {
    /**
     * Create a Foo object.
     *
     * @param foo the foo object to create in Azure
     * @return the response for creating the foo object
     * @throws HttpResponseException An unsuccessful response is received
     */
    public CreateFooResponse createFoo(Foo foo) {
        /* REST call to create foo */
    }
}

Project structure

extension-base

This contains the base classes and utilities for creating an AutoRest extension in Java. It handles the JSON RPC communications with AutoRest core, provides JSON and YAML parsers, and provides the POJO models for the code model output from modelerfour.

Extend from NewPlugin.java class if you are writing a new extension in Java.

javagen

This contains the actual generator extension, including mappers that maps a code model to a Java client model, and templates that writes the Java client models into .java files.

fluentgen

This contains the generator extension for Azure Management Libraries.

tests

This contains the generated classes from the test swaggers in src/main. The code here should always be kept up-to-date with the output of the generator in javagen.

This also contains test code for these generated code under src/test. Running the tests will hit the test server running locally (see https://github.com/Azure/autorest.testserver for instructions) and verify the correctness of the generated code.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Autorest plugin configuration

Javagen

use: $(this-folder)/javagen
use: $(this-folder)/fluentgen
use: $(this-folder)/androidgen

Help

help-content:
  java:
    activationScope: java
    categoryFriendlyName: Java Generator
    settings:
      - key: enable-xml
        type: bool
        description: Generates models and clients that can be sent in XML over the wire. Default is false
      - key: client-side-validations
        type: bool
        description: Generate validations for required parameters and required model properties. Default is false.
      - key: generate-client-as-impl
        type: bool
        description: Append "Impl" to the names of service clients and method groups and place them in the `implementation` sub-package. Default is false.
      - key: generate-client-interfaces
        type: bool
        description: Implies `--generate-client-as-impl` and generates interfaces for all the "Impl"s. Default is false.
      - key: generate-sync-async-clients
        type: bool
        description: Implies `--generate-client-as-impl` and generates sync and async convenience layer clients for all the "Impl"s. Default is false.
      - key: implementation-subpackage=STRING
        type: string
        description: The sub-package that the Service client and Method Group client implementation classes will be put into. Default is `implementation`.
      - key: models-subpackage=STRING
        type: string
        description: The sub-package that Enums, Exceptions, and Model types will be put into. Default is `models`.
      - key: add-context-parameter
        type: bool
        description: Indicates whether the `com.azure.core.util.Context` parameter should be included in generated proxy methods. Default is false.
      - key: context-client-method-parameter
        type: bool
        description: Implies `--add-context-parameter` and indicates whether the `com.azure.core.util.Context` parameter should also be included in generated client methods. Default is false.
      - key: sync-methods
        type: string
        description: \[all|essential|none] Specifies mode for generating sync wrappers. Supported value are <br>&nbsp;&nbsp;`essential` - generates only one sync returning body or header (default) <br>&nbsp;&nbsp;`all` - generates one sync method for each async method<br>&nbsp;&nbsp;`none` - does not generate any sync methods
      - key: required-parameter-client-methods
        type: bool
        description: Indicates whether client method overloads with only required parameters should be generated. Default is false.
      - key: custom-types
        type: string
        description: \[COMMA,SEPARATED,STRINGS] Specifies a list of files to put in the package specified in `--custom-types-subpackage`.
      - key: custom-types-subpackage
        type: string
        description: The sub-package that the custom types should be generated in. The types that custom types reference, or inherit from will also be automatically moved to this sub-package. **Recommended usage** You can set this lue to `models` and set `--models-subpackage=implementation.models`to generate models to `implementation.models` by default and pick specific models to be public through `--custom-types=`.
      - key: client-type-prefix
        type: string
        description: The prefix that will be added to each generated client type.
      - key: model-override-setter-from-superclass
        type: bool
        description: Indicates whether to override the superclass setter method in model. Default is false.
      - key: low-level-client
        type: bool
        description: Indicates whether to generate clients and methods as protocol(low level) clients and methods. Default is false.
      - key: client-flattened-annotation-target
        type: string
        description: \[TYPE,FIELD] Indicates the target of `@JsonFlatten` annotation for `x-ms-client-flatten`. Default is `TYPE`. If value is `FIELD`, it implies `require-x-ms-flattened-to-flatten=true`.
      - key: disable-client-builder
        type: bool
        description: Indicates whether to disable generating the `ClientBuilder` class. This is for SDK that already contains a hand-written `ClientBuilder` class. Default is false.
      - key: skip-formatting
        type: bool
        description: Indicates whether to skip formatting Java file. Default is false.
      - key: polling
        type: string
        description: Configures how to generate long running operations. See [Polling Configuration](https://github.com/Azure/autorest.java#polling-configuration) to see more details on how to use this flag.

  javafluent:
    activationScope: fluent
    categoryFriendlyName: Java fluent Generator
    settings:
      - key: fluent
        type: string
        description: Enum. `LITE` for Fluent Lite; `PREMIUM` for Fluent Premium. Case insensitive. Default is `PREMIUM` if provided as other values.
      - key: fluent-subpackage
        type: string
        description: String. The sub-package that vanilla client and builder will be put into. Default is `fluent`.
      - key: pom-file
        type: string
        description: String. Name for Maven POM file. Default is `pom.xml`.
      - key: package-version
        type: string
        description: String. Version number for Maven artifact. Default is `1.0.0-beta.1`.
      - key: service-name
        type: string
        description: String. Service name used in Manager class and other documentations. If not provided, service name is deduced from `title` configure (from swagger or readme).
      - key: sdk-integration
        type: bool
        description: Boolean. Integrate to [azure-sdk-for-java](https://github.com/Azure/azure-sdk-for-java/). Default is `false`. Provide `output-folder` as absolute path for best performance.
      - key: generate-samples
        type: bool
        description: Boolean. Generate samples from `x-ms-examples` in swagger. Default is `false`.
      - key: add-inner
        type: string
        description: CSV. Treat as inner class (move to `fluent.models` namespace, append `Inner` to class name).
      - key: remove-inner
        type: string
        description: CSV. Exclude from inner classes.
      - key: rename-model
        type: string
        description: CSV. Rename classes. Each item is of pattern `from:to`.
      - key: remove-model
        type: string
        description: CSV. Remove classes.
      - key: preserve-model
        type: string
        description: CSV. Preserve classes from clean-up.
      - key: name-for-ungrouped-operations
        type: string
        description: String. Name for ungrouped operation group. Default to `ResourceProviders` for Lite.

About

Extension for AutoRest (https://github.com/Azure/autorest) that generates Java code

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

64 tags

Packages

No packages published

Languages

  • Java 99.5%
  • Other 0.5%