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.312.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87dbecdaf38d546971858ed2bacbff117a6e7b622815c4ff551f016b6429f9b5 |
|
MD5 | b51751dff59ea00c00588ca99a4467d0 |
|
BLAKE2b-256 | 7e708acc36a1d2d709c8f8457bd02b1d24571a8933250ef9332ccdb862d52241 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.312-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2aa6f1c0702ac666feffb1387763429ef7f1f5ef6976f8739b7723ae4c136807 |
|
MD5 | c90287310207a357ea87301b2daed600 |
|
BLAKE2b-256 | 27a70b8a7ede81dbae6e985fa7772be811871ed6154270e93e3aec0a7bdcb644 |