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.776.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93459a361d9b0f7ef55b571b181f8d47b6ebef9fea0be8370d364a7ab92dac32 |
|
MD5 | 0a4c025b0bd37a040efd224080adc092 |
|
BLAKE2b-256 | e90fcffb1f73a87dc24a6ab5659c99e90105987c9d948267871477ff740e3d07 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.776-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9337f0da347880898099a3933495225d3115e660c7de1728ef8cfbc0b78904b3 |
|
MD5 | 40799931b0a32ce649570928e520c3f2 |
|
BLAKE2b-256 | 355f8a0d805a1ea0b21cbd6d04adafea2e57c057c365690eb0603c6c126a66eb |