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.917.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f89e21edbdc92415f113e4cc3b2f718c3edee764f6a075c58795810b51ad905 |
|
MD5 | 90ae8c86d3d39af93be1fe7c138b9a85 |
|
BLAKE2b-256 | ca734b3b6112aef300bdf2821d9227bbdf97b0d3a2c7e503244ee0122718b157 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.917-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc0c05e6df3f69b0deaf069b724f12c68c2434353d5b645fc5b2595d8e21e878 |
|
MD5 | 21c8a2b9b45875800097ec5fd3fc41aa |
|
BLAKE2b-256 | bf3157bc0b2cae4687c993799b27bfe156ffb11156323c7afa4eead6db7c20b5 |