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.838.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7f14a546d817d2c3860dc27bdf0052bce303b722c85b2444fd389f850de6d43 |
|
MD5 | c377f515b0f9f5e5914aa8172d6710f4 |
|
BLAKE2b-256 | 433aa4a3b9bd1b4521c73fcf061d3dcc0190d0c1df9f2c246f3d23435c7cf366 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.838-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f103d03b19f2266c29c6ff66fe46bfae37802f805e7e1a7f63af1f8fe8601f9 |
|
MD5 | 20eada874584a3a24b06e3ae8f3104c1 |
|
BLAKE2b-256 | 24011a71700b96974ba4201ba7bf7c1eec7843af4e507b15b4f9f70cc7828c41 |