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.81.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff9afd46664c8cb4d7857631f5c0e16ef29e4859e3ed4fc2a4aa08f95e4350de |
|
MD5 | 630a67c87576b61b1837b5de8a8079b8 |
|
BLAKE2b-256 | 4baa63b4864fbe1667bc86356329357d10cc5f157888e65f1140c1784e801f63 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.81-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95abe211daa67a11b4a176a22a75d27fec036191347609b8f94f5a52c5865f80 |
|
MD5 | fe20454449f2a29f8aa8e7aa9d623f68 |
|
BLAKE2b-256 | e5f298c345b1929c93a8afd91aa8e6651050f1ff2b5dc0cf239a95b9a886d8e5 |