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.626.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5b4c001fd263317a7dfd38517447998a87ecc6d91914ce931fb6f79455cce17 |
|
MD5 | e747d39463b63b437979e7b34d5e2ae8 |
|
BLAKE2b-256 | a6be2ff9da18ecbbc52c08bbd2c5b45513c51ac3699f004eeb6311b285c9aac8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.626-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73ec33e61103f28bef46d310adea6426965a83a7ae918f699936c00b8455ab5b |
|
MD5 | 0f8456d5912fe60fcdccf979ea0872bd |
|
BLAKE2b-256 | 8f4bc84b93171a8e5ac67cdb8839f366837adf85b7e096ae9789a1086e51442e |