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.218.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45ccf30a4eeee89f7d4a2f72f48954beff5d50e1f2feed2c3e461d7dbcb8bea2 |
|
MD5 | 28ae04065ab3c6c0ba5268b158a7217b |
|
BLAKE2b-256 | be91e1a96c1d7545e86dac060ef73ccc5b7eb218c630a84759cf0fb9e5e3610a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.218-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea788fd7aa609aaf8e5bdbc9fa9d642debdbdf6a3878e7d1dda1ef1dc4087b30 |
|
MD5 | 518e029907f6e9e20e24894ca401dcfa |
|
BLAKE2b-256 | c9ab49ba32fe62183aa65952cd4433eb5c8546cab3d663c1454992469028a4e5 |