Package software.aws.awsprototypingsdk.openapigateway

Interface OpenApiGatewayProjectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OpenApiGatewayPythonProjectOptions, OpenApiGatewayTsProjectOptions

All Known Implementing Classes:

OpenApiGatewayProjectOptions.Jsii$Proxy, OpenApiGatewayPythonProjectOptions.Jsii$Proxy, OpenApiGatewayTsProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.61.0 (build abf4039)",
           date="2022-07-07T06:39:53.736Z")
@Stability(Experimental)
public interface OpenApiGatewayProjectOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options common to all open api gateway projects.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OpenApiGatewayProjectOptions.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 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 String	getSpecFile()	(experimental) The path to the OpenAPI specification file, relative to the project source directory (srcdir).
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.

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.

getSpecFile

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

(experimental) The path to the OpenAPI specification file, relative to the project source directory (srcdir).

Default: "spec/spec.yaml"

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 OpenApiGatewayProjectOptions.Builder builder()

Returns:

a OpenApiGatewayProjectOptions.Builder of OpenApiGatewayProjectOptions