Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.865.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9352109f89d216868daebc274ccf0f6952623ec4f187e9edc49999c3a7fe68d |
|
MD5 | 836221e27f59ae5b82ab031345840b03 |
|
BLAKE2b-256 | c3c4590c44dde1792f2869d187679cac55e37736f0240b771e74061b3b730439 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.865-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b57c432b3a4eef53402e66409c77931ad0d2c0c0fb3baf1dde6f860050e5d7c8 |
|
MD5 | 871956f8b53cef4fd34c6e941d69cc34 |
|
BLAKE2b-256 | 784502043213aae7b594cc4bc4134d94d645b2d185b9d8b6bb5849351e35230f |