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.334.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7de83e9e9c2fa4980e6b15159eb571779b667c9e9285bb3a7e30cbf7f41aa24 |
|
MD5 | d387969472c58c36c226a2a6ed10f264 |
|
BLAKE2b-256 | 50850ea8a1c6c9e74516e30666811de5adac8a761f2ae3b94fcf5e9cb401b2fb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.334-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14f30bff7b02ccf65b783856aa43743dafe548f98e7c661a4d547bfb2d202534 |
|
MD5 | 7a00b9de454bde1f93dc9ca7c879f6bb |
|
BLAKE2b-256 | f73234b3e30adb4b3060666c7c9da9ae4499eab38016612157ff35701045c40f |