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.674.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 871d9ec6eaabcac390f1bb6cd9577a0149915074f833bc38b80dc44cd5be6ba5 |
|
MD5 | b4fdd5575a80e32b9ec364b3669fff94 |
|
BLAKE2b-256 | 4ff04f3ee8dd82640a04164d1fcf817aef46b3421e9a30418ff4d65372a2e861 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.674-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ec222990341feb4bf76f6b8148ebee7c71da54694f2f472f67f5ceac76134f5 |
|
MD5 | bb13c47273613178b1e2d42238080af0 |
|
BLAKE2b-256 | b9cd63191963bd8bf7be2d6445d5e3e439122717a72c6d72bc65f73297b23049 |