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.295.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f20cc778c32d7a41f216e77b896070e6e94bbff10085b680e7ae73db79b1cd6 |
|
MD5 | db1e553a504cb8a022670eff0894a671 |
|
BLAKE2b-256 | 3ea4be480c5da0980d178b84bae9bd2df030aeec3f1211d0c79ab128440fd9f5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.295-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b106637d96f196e5ccc70c4cc953ed6bccb6f52210a7fb8bb9cdd119af8b5d29 |
|
MD5 | e4286b51373df9345f63570d4b191cc1 |
|
BLAKE2b-256 | b30fa2766f149e6aecba6be35826efbd89a80c1814cc3237f86d4712a05fb4b0 |