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.697.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3a22885fc392cf6d817cfe0493400c8ee667a5b6a67fa6f868f124d816ec514 |
|
MD5 | 52e2413c2d8a8b87e431a8cefb4a5b7a |
|
BLAKE2b-256 | 260dd254bf5af384725eb0a0c7a587a9e8d4d42234707ac4bbc48f318b5c7aed |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.697-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5c6157dd9d80effd3b75ac60e650b087d8f58f169253b14b2e5a8f594d228a2 |
|
MD5 | e4016aea5c1d41c11d57a90807ee3d9f |
|
BLAKE2b-256 | 1caa6a8f76b43015a4069f647fae48256d48cb32f4ea5ee121762198f612d187 |