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.729.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b09ec1b62d8abde8bc3eee975ce58e20d9e60219246867eda390bdfa2e730551 |
|
MD5 | edb2946001f3a66104d968d64da4a256 |
|
BLAKE2b-256 | 1cdff79662c59cf6df535adbacee069e6b9997f092a809d382ced66aea0939c0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.729-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 680e121c6f311b7c58738714b6fbae9d904fa36a6cf927392d91547b1833f485 |
|
MD5 | 0e576292af906919bf61cc16d54cd62a |
|
BLAKE2b-256 | b4f3c1de635280dc6e5a5b6e1f28edfc1bc3854b1e2a5454f3cdd205feb80079 |