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.922.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c42ed551fa608350b401e6f93df8ecc9684490bb0d7ce33fea3bd058bdcdd0c3 |
|
MD5 | 6b348a548b36c813ef80877157571dea |
|
BLAKE2b-256 | 4516ceec1701a9d939b708f7dad5bedfd3e6b065df7e10a60a403185da3fb80e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.922-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55faa22bb09d13172bab0434130179c5700f62a9f77aaad879300904724e42e6 |
|
MD5 | 700bd3914193ef3f7524ce7584e0696e |
|
BLAKE2b-256 | 3dbd0b1cb8ab3f1ed0fafa07a2debe44e8905b8701fce4c89a538178d3bbe850 |