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.731.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4ca74c73c1fe3d7dec4f7c263d2f94a8304addb7e8ac66faf46812ff5893c2c |
|
MD5 | 8b8b461182dc6410d7cdfdb399aa2d21 |
|
BLAKE2b-256 | ab0d9fc07d4f8a73402a4c0b52d1449a5eeeade5c4e01f81fd402bc3e87a32eb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.731-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 416bf7672638b95ba16f1e83d454313a21347958430c32e2c2c910c682f1748f |
|
MD5 | 8e8b00063aba81cb12d3a83d7d0cfcb4 |
|
BLAKE2b-256 | b2f5eca1074e15f6f603ef297725770e8076fc20c648c13ecad7a54550ecd7f1 |