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.657.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07031e40e532c13002ed357d538c7a2ba159f0bad01b4766331f9d53a921ab95 |
|
MD5 | 77114bb80fbac14331641b3e30592256 |
|
BLAKE2b-256 | 099ae4fa0283514ca3833f477593f4b78f7f6c9753a535fd3d041fc44ae532d4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.657-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 160629af55d539da6a7c38a1d8b84b9bb3e6937c23e8cc36b529444a95e7511a |
|
MD5 | d3a42d42212a14f8e42c6f78fcd185b3 |
|
BLAKE2b-256 | dc86e226f0ab5d404d5a7a7cf2febbc0115f6b3ca02b95e2812c84d6f4a1ea9e |