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.100.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1806f55197534eff35844a89e82d1b9a9541a4f58c5843fda04cb75d66d4eafa |
|
MD5 | 2ab775a79983ccf785e55f3d8d5e9950 |
|
BLAKE2b-256 | 2920b8f9f902edd824a01f5ab6d3291f3b2588066bbcc7c9a8c976318fd61151 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.100-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9005abb1d991e742de5406d53c2413f0813901a8bbc24de4cd1d3d1df39b069 |
|
MD5 | 5166536b728e9eb3da73f0b099396908 |
|
BLAKE2b-256 | e400c66322ac808023154483a71b73904a8e52a2290b8f45c4408a6e69646296 |