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.622.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31da874146268bee0228a8bcd9803c181ea2c06ecec5a4f7770f958a68bd44f9 |
|
MD5 | af13312eb25bfae886beefab260ad19f |
|
BLAKE2b-256 | 76058da07a952371ee7e2dcb24614b37b8121ac4c6b6de9769ba614c2e92be67 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.622-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0675522e2dfd59075b66002fbd9aaf9c419866c25e52f02729d3874d04a87adc |
|
MD5 | d1f1c864dbf6141f1e22f8056d31fe85 |
|
BLAKE2b-256 | 5f259ac9657274128d7fce7a4ab0368290fb974a665acce7c2ef36ef95b8f7f9 |