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.226.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3812684b5a30917d01fe65815cb2f2c91c6b4c0236a8ed360218f85b9a0d6b48 |
|
MD5 | 28dce87a4bf24c6c4d8e2962b543c03f |
|
BLAKE2b-256 | c5318ea661bf0b0eaf8531596f0c6c5d0be2cdc6c8f1b1b64438c775a68a1f82 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.226-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb8e6949585e73727e458258ccade10e73740448a1d00fdbeb3d88e00d49eea1 |
|
MD5 | 5b2b77a8bd90dd4e223bbdf966583cda |
|
BLAKE2b-256 | 4cc0ddaa8667f5944e38cea9386b4ebca621da9eede5c1724b3a2182ca7d410c |