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.389.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e3f5aa0209dba22235e063ce70066458a1d4c5781d75176ef3a07db1ae61dae |
|
MD5 | aebe5aeec301dc8157d4b62160343664 |
|
BLAKE2b-256 | 98564cf96889b4011763d18b114f21df4aa2261c342230eeff10dee0774f84ac |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.389-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a447015a517a0f5c05848b86ec18437812c9b161644b0d07811d760047e70d4 |
|
MD5 | ca516b75fff37fdb0b0f13e281733c0c |
|
BLAKE2b-256 | 6d0ef5621425669fdaa17a517b76d923640bf1acaefb52a71f98ce009a02c46a |