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.201.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 496fcf49170aae6e65ebf33e37ac3496bb214310674d1cec93ee9ed2808558c5 |
|
MD5 | 4463cf8e4480f664839dae28fcfad727 |
|
BLAKE2b-256 | fd49fac15c0322b42e3ce2dffca4cf974615b02f9f43165594cbe5c542b6b3ad |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.201-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c32060c1e6d21b6d4459e707f11d59c7e57547fa45e4d66d0d364af2a238f3ed |
|
MD5 | ef7b5145b7e9b7f696a44061cd1a469b |
|
BLAKE2b-256 | d9afaf243f68721a6f75f27e38b44478af79a89174340006218549095ccca392 |