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.641.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf316f5b5b40060164b3676a36e49fb06a4bfcc1ee4dc8ea5b752f75a0b38352 |
|
MD5 | 46485a190cf1e6cb8a8d72fcf3a6941b |
|
BLAKE2b-256 | 8de12bbca63b4e14b21e78085510b85266d27101e5a626bc7969b73807ee41c6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.641-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f5366732d0c4a24f53cceb5262bdaa4ba1845871937425fb634e5d543e8367c |
|
MD5 | bd290ffde70d349ee2e3097caa2fda77 |
|
BLAKE2b-256 | 8ef5323344889e2f86db5ef19418caf1d323a23e6fdda1c72d5475228646adb7 |