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.385.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38919a80221027d37c1c8ec05b503009e0b10068df318d0f085256d247e0ef76 |
|
MD5 | 9d8092fe5ef622c8c9e7712a8514fcba |
|
BLAKE2b-256 | e01d0828b3e1ae02ad70bc5f53651ac618aead86d384398f83a6cf625f92f1d5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.385-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad5a6037280ddc4f53433cecbc98f5a9b3f12f8816eff2ff95d2d293070e96e5 |
|
MD5 | 886a491e3804649017af6be3bff1f2f2 |
|
BLAKE2b-256 | b2658b231460322fd1feefcb69455a61df4eab6380bc9b37d04ea82de87bc6f6 |