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.612.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa44315753a43cc25c4a8a383cf7928af2f1c08348da1202877836cad5f22f8e |
|
MD5 | 6d0f3e1506087ef8e1ccf96e77f7812e |
|
BLAKE2b-256 | 203590ee230c17a3d566c94bd810cfbc5d925254b306f1dcb38ad65f77ca4f35 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.612-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2694893f46519ea315dc6af5549c22726be87a5ff91f0390910547194a7006b |
|
MD5 | 084d3f74ebf9a60ff8dd8392d71fc02e |
|
BLAKE2b-256 | 5c576691cdedf0db48093c3b0dce71784bef3dc1fae6bc27bc73128ca8545750 |