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.427.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b346cbf3c053d6aba05c48a88e30938896f18ce936a831410ba9c203359813c |
|
MD5 | eca178324ae46bdb4e996fab98793449 |
|
BLAKE2b-256 | e9d0f81433e8bf48f9700fe968cafc6d925af3eac931c2274d1a736da08b22e8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.427-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 762eb86ef2546176ffa0413b43d6407b39d46a918bbed58739d0557bd05df475 |
|
MD5 | caea889a8e9b1e3bc15b153f3d2080e5 |
|
BLAKE2b-256 | ce12c9406685c0578a6747fe87be7800d053d25e4339c2bb7111d0eccb507694 |