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.590.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a93515c35b12bf120b558d48f040e83bbbecffd39aa153e9bd95847b9d516f6c |
|
MD5 | 54d75f27a81cafbbd7261ac7764fee08 |
|
BLAKE2b-256 | 608b9f6fdbef7ca83aa79275ed5c37849d816478fe11a83be6a840a09ea6c0e3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.590-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f6447ea59ec790e5e4d1804ee7e5f6e242e9969856d6e1c8ae22bb306e9ae46 |
|
MD5 | 83883e34397909a237f84e46cad3c18b |
|
BLAKE2b-256 | d0887e4f0bcce129bcc89de08865a5934d8b31ab82d1da5d8829cd8c831ff197 |