Package software.aws.awsprototypingsdk.openapigateway

Class OpenApiGatewayJavaProject

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    Direct Known Subclasses:
    SmithyApiGatewayJavaProject
    @Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T09:33:12.701Z")
@Stability(Experimental)
public class OpenApiGatewayJavaProject
extends io.github.cdklabs.projen.java.JavaProject
    (experimental) Synthesizes a Java Project with an OpenAPI spec, generated clients, a CDK construct for deploying the API with API Gateway, and generated lambda handler wrappers for type-safe handling of requests.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenApiGatewayJavaProject.Builder
      (experimental) A fluent builder for OpenApiGatewayJavaProject.

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

    • Field Summary

      • Fields inherited from class io.github.cdklabs.projen.Project

        DEFAULT_TASK

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getApiSrcDir()
      (experimental) The directory in which the api generated code will reside, relative to the project srcdir.
      Boolean getForceGenerateCodeAndDocs()
      (experimental) Force to generate code and docs even if there were no changes in spec.
      Map<String,​io.github.cdklabs.projen.Project> getGeneratedClients()
      (experimental) References to the client projects that were generated, keyed by language.
      String getGeneratedCodeDir()
      (experimental) The directory in which generated client code will be generated, relative to the outdir of this project.
      io.github.cdklabs.projen.java.JavaProject getGeneratedJavaClient()
      (experimental) A reference to the generated java client.
      String getSpecDir()
      (experimental) The directory in which the OpenAPI spec file(s) reside, relative to the project srcdir.
      String getSpecFileName()
      (experimental) The name of the spec file.
      protected OpenApiGatewayJavaProjectOptions preConstruct​(OpenApiGatewayJavaProjectOptions options)
      (experimental) This method provides inheritors a chance to synthesize extra resources prior to those created by this project.

      • Methods inherited from class io.github.cdklabs.projen.java.JavaProject

        addDependency, addPlugin, addPlugin, addTestDependency, getCompile, getDistdir, getJunit, getPackaging, getPom, getProjenrc

      • Methods inherited from class io.github.cdklabs.projen.github.GitHubProject

        annotateGenerated, getAutoApprove, getDevContainer, getGithub, getGitpod, getProjectType, getVscode

      • Methods inherited from class io.github.cdklabs.projen.Project

        addExcludeFromCleanup, addGitIgnore, addPackageIgnore, addTask, addTask, addTip, getBuildTask, getCommitGenerated, getCompileTask, getComponents, getDefaultTask, getDeps, getEjected, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getTasks, getTestTask, postSynthesize, preSynthesize, removeTask, runTaskCommand, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • OpenApiGatewayJavaProject

        protected OpenApiGatewayJavaProject​(software.amazon.jsii.JsiiObjectRef objRef)

      • OpenApiGatewayJavaProject

        protected OpenApiGatewayJavaProject​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • OpenApiGatewayJavaProject

        @Stability(Experimental)
public OpenApiGatewayJavaProject​(@NotNull
                                 OpenApiGatewayJavaProjectOptions projectOptions)
        Parameters:
        projectOptions - This parameter is required.

    • Method Detail

      • preConstruct

        @Stability(Experimental)
@NotNull
protected OpenApiGatewayJavaProjectOptions preConstruct​(@NotNull
                                                        OpenApiGatewayJavaProjectOptions options)
        (experimental) This method provides inheritors a chance to synthesize extra resources prior to those created by this project.

        Return any options you wish to change, other than java project options.

        Parameters:
        options - This parameter is required.

      • getApiSrcDir

        @Stability(Experimental)
@NotNull
public String getApiSrcDir()
        (experimental) The directory in which the api generated code will reside, relative to the project srcdir.

        This will also be used as the package for the api project.

      • getGeneratedClients

        @Stability(Experimental)
@NotNull
public Map<String,​io.github.cdklabs.projen.Project> getGeneratedClients()
        (experimental) References to the client projects that were generated, keyed by language.

      • getGeneratedCodeDir

        @Stability(Experimental)
@NotNull
public String getGeneratedCodeDir()
        (experimental) The directory in which generated client code will be generated, relative to the outdir of this project.

      • getGeneratedJavaClient

        @Stability(Experimental)
@NotNull
public io.github.cdklabs.projen.java.JavaProject getGeneratedJavaClient()
        (experimental) A reference to the generated java client.

      • getSpecDir

        @Stability(Experimental)
@NotNull
public String getSpecDir()
        (experimental) The directory in which the OpenAPI spec file(s) reside, relative to the project srcdir.

      • getSpecFileName

        @Stability(Experimental)
@NotNull
public String getSpecFileName()
        (experimental) The name of the spec file.

      • getForceGenerateCodeAndDocs

        @Stability(Experimental)
@Nullable
public Boolean getForceGenerateCodeAndDocs()
        (experimental) Force to generate code and docs even if there were no changes in spec.