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.223.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | be2f3f15e10c4aba356fd070a88595f2ca9f9e5f72792912fc558ee24234c02c |
|
MD5 | ec273ae85fac4ae8601cf1877ef44fe8 |
|
BLAKE2b-256 | 9f7b5c0d3217fc48d1e594b14929f5beddbfad77941fbec45ed522444f14da29 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.223-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9e6220f754b42d2c0934c58620ba7bdc5a4c57ebe05e9027b0a405dc7d3f3b7 |
|
MD5 | 6691a61e19e12d85b86e49195524f5e6 |
|
BLAKE2b-256 | 0633fd9eef472f629de08ac595656b340f00ddc15396e5bc23756d70c5ec69a7 |