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.809.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29eaafc2ebeb2bd86b5457af99939f0bda808644683cf34c74877dd57e78f072 |
|
MD5 | d25b1a38ab48a528c849f37c89039ea0 |
|
BLAKE2b-256 | 48e10d9250ab192b809fbe0267bf5611eb0050238f3eb4173fef7f2101f583f4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.809-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70ab311b399d03ea3beaaadc9334a2ab6a8585d86843da3f529b930b23039823 |
|
MD5 | 549a8e6040112ecfb7512923debe0cb5 |
|
BLAKE2b-256 | ae2d832edb96a2117dd3fdc0468f5e80f385dd9063fce1935266401b5f9b3a26 |