Package software.aws.awsprototypingsdk.openapigateway

Class OpenApiGatewayTsProject

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    Direct Known Subclasses:
    SmithyApiGatewayTsProject
    @Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-01T04:12:25.068Z")
@Stability(Experimental)
public class OpenApiGatewayTsProject
extends io.github.cdklabs.projen.typescript.TypeScriptProject
    (experimental) Synthesizes a Typescript 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  OpenApiGatewayTsProject.Builder
      (experimental) A fluent builder for OpenApiGatewayTsProject.

      • 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.typescript.TypeScriptProject getGeneratedTypescriptClient()
      (experimental) A reference to the generated typescript client.
      io.github.cdklabs.projen.YamlFile getPnpmWorkspace()
      (experimental) Reference to the PNPM workspace yaml file which adds the dependency between this project and the generated typescript client when this project is used in a monorepo, and the package manager is PNPM.
      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.
      void postSynthesize()
      (experimental) Called after all components are synthesized.
      protected OpenApiGatewayTsProjectOptions preConstruct​(OpenApiGatewayTsProjectOptions options)
      (experimental) This method provides inheritors a chance to synthesize extra resources prior to those created by this project.
      void preSynthesize()
      (experimental) Called before all components are synthesized.

      • Methods inherited from class io.github.cdklabs.projen.typescript.TypeScriptProject

        getDocgen, getDocsDirectory, getEslint, getLibdir, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigEslint, getWatchTask

      • Methods inherited from class io.github.cdklabs.projen.javascript.NodeProject

        addBins, addBundledDeps, addCompileCommand, addDeps, addDevDeps, addFields, addKeywords, addPackageIgnore, addPeerDeps, addTestCommand, getAllowLibraryDependencies, getArtifactsDirectory, getArtifactsJavascriptDirectory, getAutoMerge, getBuildWorkflow, getBuildWorkflowJobId, getBundler, getEntrypoint, getJest, getManifest, getMaxNodeVersion, getMinNodeVersion, getNodeVersion, getNpmignore, getPackageManager, getPackageValue, getPrettier, getPublisher, getRelease, getRunScriptCommand, getUpgradeWorkflow, hasScript, removeScript, renderWorkflowSetup, renderWorkflowSetup, runTaskCommand, setScript

      • 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, 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, removeTask, 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

      • OpenApiGatewayTsProject

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

      • OpenApiGatewayTsProject

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

      • OpenApiGatewayTsProject

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

    • Method Detail

      • postSynthesize

        @Stability(Experimental)
public void postSynthesize()
        (experimental) Called after all components are synthesized.

        Order is not guaranteed.

        Overrides:
        postSynthesize in class io.github.cdklabs.projen.Project

      • preConstruct

        @Stability(Experimental)
@NotNull
protected OpenApiGatewayTsProjectOptions preConstruct​(@NotNull
                                                      OpenApiGatewayTsProjectOptions 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 typescript project options.

        Parameters:
        options - This parameter is required.

      • preSynthesize

        @Stability(Experimental)
public void preSynthesize()
        (experimental) Called before all components are synthesized.
        Overrides:
        preSynthesize in class io.github.cdklabs.projen.Project

      • getApiSrcDir

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

      • getForceGenerateCodeAndDocs

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

      • 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.

      • getGeneratedTypescriptClient

        @Stability(Experimental)
@NotNull
public io.github.cdklabs.projen.typescript.TypeScriptProject getGeneratedTypescriptClient()
        (experimental) A reference to the generated typescript 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.

      • getPnpmWorkspace

        @Stability(Experimental)
@Nullable
public io.github.cdklabs.projen.YamlFile getPnpmWorkspace()
        (experimental) Reference to the PNPM workspace yaml file which adds the dependency between this project and the generated typescript client when this project is used in a monorepo, and the package manager is PNPM.