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.723.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43d728f9e09367e3c195e05451d6dcabd9b07d1c35fc5f0ea275b7820f628f68 |
|
MD5 | 9a13f80ab38b63cc3f6580fe94ee4ca0 |
|
BLAKE2b-256 | 96340a30ee698da0028464b905b061aeaff1d6b708c1e0259ce5f5b53dadf0d3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.723-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f2320e544a87e78f523f20ae3a55f6802168716f419a86ca9100ef9b7c09dcf |
|
MD5 | e2341d82c8ab1c58326c224a481da288 |
|
BLAKE2b-256 | d835613cb72ccb179ebe024e104b540393f3cc2021a3737999c43b6844e850ea |