API reference / @backpack/cdk-constructs / SwaggerUIConstruct

Class: SwaggerUIConstruct

CDK Construct that accepts an API Gateway with OpenAPI specs and adds a Swagger UI to it.

Currently only supported when using a InlineApiDefinition.

Extends

• Construct

Constructors

Constructor

new SwaggerUIConstruct(
   scope, 
   id, 
   properties): SwaggerUIConstruct;

Parameters

Parameter	Type
scope	Construct
id	string
properties	SwaggerUiProperties

Returns

SwaggerUIConstruct

Overrides

Construct.constructor

Properties

node

readonly node: Node;

The tree node.

Inherited from

Construct.node

Methods

toString()

toString(): string;

Returns a string representation of this construct.

Returns

string

Inherited from

Construct.toString

---

isConstruct()

static isConstruct(x): x is Construct;

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

Parameters

Parameter	Type	Description
x	any	Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

Construct.isConstruct