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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 101ae3d9b87d06ba54401f85ef9e7a004a4ca03d0052564b628c544bb698a980 |
|
MD5 | b513c5fac041b2d1e023b6d6da0e19d3 |
|
BLAKE2b-256 | da03991ff7b719341527159df6ee9180f3726439653470b8d210253e8e63b668 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 616381aa945f84157484cad357b90b089f03358ea1a53bd3f703f2a3d452d056 |
|
MD5 | ab98e03e36fd8dd7716b60f737fc6835 |
|
BLAKE2b-256 | f9a7425bbcf14c0134b162ea8e6faaa43da787735b1013b45474ae69a2345f74 |