Creates an instance of RestApi.
The AWS CDK TypeScript app.
The options for configuring the RestApi.
Readonly
nodeThe tree node.
Protected
optionsThe options for configuring the RestApi.
Readonly
projectProtected
addAdds a sample handler file for a REST API resource.
The collection of file generators.
The OpenAPI specification object.
The path of the API resource.
The HTTP method of the API resource.
Protected
createProtected
createPrivate
generateGenerates sample handler files for the REST API based on the OpenAPI specification.
The collection of file generators for the sample handler files.
Protected
validateValidates a path reference in the OpenAPI specification.
The OpenAPI specification object.
The path reference to validate.
The list of visited paths to detect cycles.
True if the path reference is valid, otherwise false.
If the path reference is invalid or cyclical.
Static
isStatic
isChecks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
Any object
true if x
is an object created from a class which extends Construct
.
Generated using TypeDoc
The RestApi construct sets up an OpenAPI-based REST API for a serverless project using projen. This construct extends the projen Component to include dependencies and development dependencies required for OpenAPI and AWS Lambda, and provides methods to generate TypeScript types from the OpenAPI definition file. It also generates sample handler files for the API endpoints.
Example