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.277.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b4b4b1a2d293c348553ff135a9e961b6931a770e191d0b21f794e569a08dbde |
|
MD5 | 77831e55974713a9fd651b192b9683c5 |
|
BLAKE2b-256 | b9ab8809d30a1d8ff4526f0e22aec0a6b4527d6678c7784532784516c3a0c524 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.277-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fee74337b5af6affc3f48fa15e95a2d7b7a293b1566a167c5a1064d78d44345 |
|
MD5 | 9dfc1b8a6d32c78463b13374e37803c0 |
|
BLAKE2b-256 | 0b7cec0f7fdd2d8d37b5fdbcc15d50a1c3fe2c4c00c9458dc9acc9f48f24463f |