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.556.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b4b8606c0294290a5ee01264c3def09dc9baf78f9708d36c2bf26a5e4494add |
|
MD5 | 51c0c2650a8ed3ac1c910b77763cb4c0 |
|
BLAKE2b-256 | 05e8804aeb22a4f6e64a9af7a35d56b70950a11d6e489eea4d970de331f7feae |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.556-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c6ab1f67d0215d8e48e22899bee67a1da6f7e9acab7407ed0cca9523c0a5d44 |
|
MD5 | 1b5ce31438a0e30ee45851d676320b67 |
|
BLAKE2b-256 | d9851a7bcb778dcb52f890c0b646ab85a3576f9fcabcd57336b333022c9dc918 |