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.639.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 036b3f346d5af6678ac7ea1983eaba31c0fc0e6319036416c94a9f2f99cd13c7 |
|
MD5 | eeecbb47e61bc5e37ffb30f8a00145a9 |
|
BLAKE2b-256 | e4785a5fb073feff43bfe21b75495c66afa2dc9992da194b2f7903eb73d953a1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.639-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56001b89e6c1298bad1828a8f171b53c11c005c509c9b15a617f66668fc7f74d |
|
MD5 | d68ef76e745d84f407f20a7b95d831a6 |
|
BLAKE2b-256 | b85745bddc19d77cda4accf71312f49bc53a04ed8f07c4cdf37b00b27c867429 |