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.716.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abb1e3b3e1cfd811b475dc48232feff85241d3da3c594d880956f1766610306c |
|
MD5 | 2a893e151188a4aec246820b0e1a4ce2 |
|
BLAKE2b-256 | e0b2705f928d4f72d2210aa941094dc53b90f25dad99c1e1236d798ce4ce3455 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.716-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6f3d269292a97cb84798132d550e47beb92c03c33a9706630cc9fed81fb7f75 |
|
MD5 | 62759c8fba494b6d020ea0266cc29a7b |
|
BLAKE2b-256 | aea700775fa80bf712a4b35ef17e0a63d46ae1c68fe18e7f6819110f8ce699d5 |