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.162.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c52cff922e00c6352279eaebf064069aee003fe6a531a252b80c083729796576 |
|
MD5 | 71f99e7560d8b1a163143bc9a79986b8 |
|
BLAKE2b-256 | d7d50a491543298cbe1ec3519c3569eaa6ee105071c9d21180b1fbb57c2b690c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.162-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0530a929483f3c8aaa41bca4e08c3d2db68642fd74a6c895538070682edee4cb |
|
MD5 | da3dc3818fe6d5572f86dc8a76be29dd |
|
BLAKE2b-256 | cd0b596cf46adda36c7ce11b2816837e76c6a2f761f09eb534939ed955c2dc9b |