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.568.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e0367e3a34b6a719b5fed4ec0f40008d37858f9824d17d1709c9ee1ef4776d9 |
|
MD5 | d07599203c71eba33f41fa00012c955f |
|
BLAKE2b-256 | bd07a1338482873696fc4642f31836a0328339a641374ce84457c9efce2159c4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.568-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e4897831d56d66c97795eb2fd161e3d97f039e1b551a6c78b7a5e75e466d774 |
|
MD5 | 1a5df778782d254716d38bb0a5096472 |
|
BLAKE2b-256 | 9eb6238cfe08ae4685c53542bcc4a882f6b1d769568e8722c4df51bccdc38e0c |