Package software.aws.awsprototypingsdk.openapigateway

Interface CommonApiProjectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OpenApiGatewayJavaProjectOptions, OpenApiGatewayProjectOptions, OpenApiGatewayPythonProjectOptions, OpenApiGatewayTsProjectOptions, SmithyApiGatewayJavaProjectOptions, SmithyApiGatewayProjectOptions, SmithyApiGatewayPythonProjectOptions, SmithyApiGatewayTsProjectOptions

All Known Implementing Classes:

CommonApiProjectOptions.Jsii$Proxy, OpenApiGatewayJavaProjectOptions.Jsii$Proxy, OpenApiGatewayProjectOptions.Jsii$Proxy, OpenApiGatewayPythonProjectOptions.Jsii$Proxy, OpenApiGatewayTsProjectOptions.Jsii$Proxy, SmithyApiGatewayJavaProjectOptions.Jsii$Proxy, SmithyApiGatewayProjectOptions.Jsii$Proxy, SmithyApiGatewayPythonProjectOptions.Jsii$Proxy, SmithyApiGatewayTsProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:24.783Z")
@Stability(Experimental)
public interface CommonApiProjectOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CommonApiProjectOptions.Builder	A builder for CommonApiProjectOptions
static class	CommonApiProjectOptions.Jsii$Proxy	An implementation for CommonApiProjectOptions

Method Summary

Modifier and Type	Method	Description
static CommonApiProjectOptions.Builder	builder()
default String	getApiSrcDir()	(experimental) The directory in which the api generated code will reside, relative to the project srcdir.
List<ClientLanguage>	getClientLanguages()	(experimental) The list of languages for which clients will be generated.
default List<DocumentationFormat>	getDocumentationFormats()	(experimental) Formats to generate documentation in.
default Boolean	getForceGenerateCodeAndDocs()	(experimental) Force to generate code and docs even if there were no changes in spec.
default String	getGeneratedCodeDir()	(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.
default io.github.cdklabs.projen.java.JavaProjectOptions	getJavaClientOptions()	(experimental) Options for the generated java client (if specified in clientLanguages).
default String	getParsedSpecFileName()	(experimental) The name of the output parsed OpenAPI specification file.
default io.github.cdklabs.projen.python.PythonProjectOptions	getPythonClientOptions()	(experimental) Options for the generated python client (if specified in clientLanguages).
default io.github.cdklabs.projen.typescript.TypeScriptProjectOptions	getTypescriptClientOptions()	(experimental) Options for the generated typescript client.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientLanguages

@Stability(Experimental)
@NotNull
List<ClientLanguage> getClientLanguages()

(experimental) The list of languages for which clients will be generated.

A typescript client will always be generated.

getApiSrcDir

@Stability(Experimental)
@Nullable
default String getApiSrcDir()

(experimental) The directory in which the api generated code will reside, relative to the project srcdir.

getDocumentationFormats

@Stability(Experimental)
@Nullable
default List<DocumentationFormat> getDocumentationFormats()

(experimental) Formats to generate documentation in.

getForceGenerateCodeAndDocs

@Stability(Experimental)
@Nullable
default Boolean getForceGenerateCodeAndDocs()

(experimental) Force to generate code and docs even if there were no changes in spec.

Default: "false"

getGeneratedCodeDir

@Stability(Experimental)
@Nullable
default String getGeneratedCodeDir()

(experimental) The directory in which generated client code will be generated, relative to the outdir of this project.

Default: "generated"

getJavaClientOptions

@Stability(Experimental)
@Nullable
default io.github.cdklabs.projen.java.JavaProjectOptions getJavaClientOptions()

(experimental) Options for the generated java client (if specified in clientLanguages).

These override the default inferred options.

getParsedSpecFileName

@Stability(Experimental)
@Nullable
default String getParsedSpecFileName()

(experimental) The name of the output parsed OpenAPI specification file.

Must end with .json.

Default: ".parsed-spec.json"

getPythonClientOptions

@Stability(Experimental)
@Nullable
default io.github.cdklabs.projen.python.PythonProjectOptions getPythonClientOptions()

(experimental) Options for the generated python client (if specified in clientLanguages).

These override the default inferred options.

getTypescriptClientOptions

@Stability(Experimental)
@Nullable
default io.github.cdklabs.projen.typescript.TypeScriptProjectOptions getTypescriptClientOptions()

(experimental) Options for the generated typescript client.

These override the default inferred options.

builder

@Stability(Experimental)
static CommonApiProjectOptions.Builder builder()

Returns:

a CommonApiProjectOptions.Builder of CommonApiProjectOptions