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.126.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00435a4ddacd62e02412c57dd42617103020e26155e71bacf1047ced5c42dc9b |
|
MD5 | 510686bdae857188ba12a13a4aff0eea |
|
BLAKE2b-256 | b230b6ff7db732f64defc5b25e0b994d9f81eec158f887640a9ae2a2ad9bdd99 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.126-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 410ac2aeb68e1ed783275e1cc7353e1af815c3a2a74b93745a441bd97b7b1b23 |
|
MD5 | a61fc2692d6cbc26959551be8e1d00de |
|
BLAKE2b-256 | a27e1b795f199240b74b36018a979bfc9e6182e01261a2b3e029b384b981fc59 |