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.803.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11cf6aeb09e0d7d204f14e8474ab0fc51932d954dc9be34849fe0beaf695b7a5 |
|
MD5 | dc3f9a7049f512efd2efea0d2708c4f2 |
|
BLAKE2b-256 | 327061824b081571f1c80d76451eeea08370bb4460262e72471e62c30f88881a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.803-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e89ce47b2031a3a1e6dda10274716a072702bccb5b181b1cdb383e409f388c6 |
|
MD5 | 3085946e9ae63bddb190e3b36effacb0 |
|
BLAKE2b-256 | 231df2645866e8b367933002479d92679df18fe0d9b3d59d46363ec8b11eabe4 |