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.107.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 424cfcf05805f0b21e652559897e308829ce2fd12b0e42802f2b24bf31a66ad1 |
|
MD5 | c934bcfef70f82464a65cc8471183a53 |
|
BLAKE2b-256 | 1e39e2391946799aad47684dd61558bcb66393757878afdc85117e6f3be710cc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.107-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6187680288db8b6636c8598151c1d9a649b0633b48ed106c0194cf88cd7dfb41 |
|
MD5 | a56a20b6caaf3019e6a7b2dc01a9c23a |
|
BLAKE2b-256 | 2a159a89846e733ce32e9e4d6dd6d2da285062322593b031da8b3b5febac8a3c |