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.422.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ef56f8e094b34366e0c43c6dff1d835aedccf151c6239b085e51af9ceab2705 |
|
MD5 | ac99fbbcf37e9638cb519faf05ee57aa |
|
BLAKE2b-256 | 0b9762589da4b8933bc7fa1516dd7507230e8522a2534fa1b01f8a8022cf7074 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.422-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4788a509c696d22b4550e75182ec09776161715e88d962a11070f1845affd63 |
|
MD5 | 55e82c7a96e61b5a9eaa8eacc1c60090 |
|
BLAKE2b-256 | ae2f50f2ca8310abad8d1f3a9accec1133c547cb0fb596202c265ba49f5d6b3d |