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.630.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27d129aab6cce04ff0ab1df0048993be06a17c8b19daab20a1c54d7d84097343 |
|
MD5 | 249381b5e9b028ac553ccc83efe9310e |
|
BLAKE2b-256 | 2ab4d74d730720ede354f0d71034a3876c575b33f0585e5d375539014ca2c9d5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.630-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f2f810a19398b8cf3101054fe88d7188ec9aa62d08cfe4eb987c0f2765b8ac6 |
|
MD5 | c7034cf8873f39f097b6b4c1df3c9a51 |
|
BLAKE2b-256 | a3cf0ccee20c0c22336e615d5c5ea4bfa3236bde1546034e6c837020aee3a8e3 |