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.114.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3559f8b3e7de185b4297a5d06f9b6d171d14973e33a3bd4d54deb8e5aded49af |
|
MD5 | ef9f718410a5da8fb59f895dd9185dd2 |
|
BLAKE2b-256 | 0bd11bf09e25af9172f3c2d20413cbcedf639dd6794b84c7be39868cad9e3f8c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.114-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d677e0b4271c9a1646ebdb11f6b5495337e1d2e3d08f9d68d963b0a254e08b0 |
|
MD5 | bd2cdf14494666f531eccca449805d35 |
|
BLAKE2b-256 | 6c18a6af233813fe87fb6a1e4a4d1b218ae5957c5383636b100c25a67542dd30 |