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.203.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f0914cd26b07b382655350768b77ec43e264f93e563d74fb829adb558b8c9b4 |
|
MD5 | 56a28b737935a6be718aff57378d3447 |
|
BLAKE2b-256 | 61a487e76dd9d08625cb4f3bf4e1bcb652f0d4dd36dfab94b688149db0117f33 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.203-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e30cbb1f2b345edf62de024d99b412e2639b79f7094e5b3db3ac0b1cf865e32 |
|
MD5 | df8ca3d1c117da036700bd39c62887f8 |
|
BLAKE2b-256 | d40fe8b5674e7805139604e270d622e7a7cd393a9fa0a5b4bf62f7298e5aba59 |