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.28.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66d42ba1370c44f0180161eb844f0745974a699ed3e9483638f56ff1ee85e9dd |
|
MD5 | 2787cb97ee950b4958f82ba5c543ea33 |
|
BLAKE2b-256 | 856be86dc964629d6bddc5254306c5bc5cf1b0d10a8d8748965c819885f08fb6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.28-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83a2972a8ee3933a5dbaa59599ef30de5643ff7bc9b01dc6d4f7c746affb7fa4 |
|
MD5 | f883b8bdce6ec18f5fc1301d4fa58b12 |
|
BLAKE2b-256 | 3709db2fe3fd74818b15facdaf9ac41f6e1d56f6c335bf7b2d22cca7e4895a38 |