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.208.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b456f31de5d02c743d5b8d37ead41fe483d2117f0a4a46901781ef698250300 |
|
MD5 | df12b8f37dcc8a3b06976920eeaa7c39 |
|
BLAKE2b-256 | b5f27b99c7f085c46a1a8bc9f2b58a95138d866c1225c859ba15fe0441cc71e9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.208-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88dfb586da916ac2af8370cee6e439adb5bad1bc60b7de8236ffc2828fb248f4 |
|
MD5 | 39596c0a47647cc52b9dbb48e974ce9d |
|
BLAKE2b-256 | 3948150ec2051c8569c31016ce86e1b92b2745eb296c3dda5bb7608313eac7b4 |