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.808.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b10052de3136b17f54e6c788093d19be31d1652883aaeb6b7785f38aeb611c91 |
|
MD5 | 9b6d6e56f569f5835d06dc5e2d817682 |
|
BLAKE2b-256 | bfcf3c9b514d292a6d8d6ff695645c1f1a4f3f77a9d2f011b8ee4b11ef8474b0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.808-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d57dfc2620730c484e3b79db754f4d8f189b034b782564c5faa972e4805a39e9 |
|
MD5 | e9d718b7d20c3b400ec04200503753e8 |
|
BLAKE2b-256 | 5bc53a5f218b37839759af3d1261cd8643c269bf9c0ee89a619323755fd5d6db |