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.635.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3935d4bcc8f552318b0fcf5744b33724f7df2be7f4fd9bcaa8e9fd6dc747b71e |
|
MD5 | c989ee2160da2b5b8ff609e7329f4f69 |
|
BLAKE2b-256 | fbb99671d77777ffced6070a107bf799c5e348e3705cfc355e083a28a819b65e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.635-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 115bf796358afbce9edf23e3e9f5fead697416febbb1444046cd975d7ac2dc0d |
|
MD5 | 693c3037d1ea8271c0d39cc068f5d699 |
|
BLAKE2b-256 | 78a984c4cafb2319555b70deda0602577fffb67956078c360babc84632b185de |