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.67.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e4fdc030b2df86e17e9be9781e3e25e8521ba2a5b352973045d1da8b385b4f8 |
|
MD5 | 18ae5326f8dc326925591474bde25466 |
|
BLAKE2b-256 | 70d8c711144f9233ebe8c6494c1ea8593784623ebe94f04f0e692190d39a6ea6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.67-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07a6554a9d38d6983bf067a5f90d2704867e6a8d7c835098325409fe60ad35e0 |
|
MD5 | c4c1baae11d91e7ffc0d52600012089b |
|
BLAKE2b-256 | b4f4f64e0e125e95fb2c31dc802286ee610e8079584774ec196c441d068f0eb7 |