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.265.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2ad2d11e7eec06e688796d2a3ffb25c755dd090476e6bb5204cd8cf7d57c9b5 |
|
MD5 | 7f2ee7b9d768749b5122c1f6fd72483e |
|
BLAKE2b-256 | 5bd5fd896eca19cf745100676d50fa43b7debd6c5d5f953200554b807f4d25f0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.265-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c80575098a60cf81bf6105fe159283c361d1c389b968097ac1734677340ef8c |
|
MD5 | 467f1f25891cac71c451d3f90bea05c6 |
|
BLAKE2b-256 | e362a9fcf4f7e34b1910b03f95d73d0861ba25eee3aaf0697ced2b634bbdf01b |