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.465.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21994916ba3576b443e533f8aea80b4b1d7ba5a3747b3c5777df9d644f5b6ce1 |
|
MD5 | 781a9616e69cad38a711b9407873a679 |
|
BLAKE2b-256 | 36ccd61ff4ed1330bc1f22719686a1e99a247ecff7d262b840df395562cc96df |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.465-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67fb07c2fba5fccad890ace1c374784fbfa066f180c8302900b57f39d3588757 |
|
MD5 | b65d61198d5459a11e7282f93907533f |
|
BLAKE2b-256 | 092e1ff73c52e5dfb94cb4146b917ee2e16cbd8b7e6feed90bf859c9848cf97f |