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.236.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72fee9735b12444c390c897301cf7c6e583cedc606d0061e2b5477358c362ac4 |
|
MD5 | 36de64ca60740942922fc482b8bb02fb |
|
BLAKE2b-256 | 3450eb8a9e76dacac5e8405633745f18681800bda7954188a6111b33a90b4251 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.236-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a63c7f5fafdd182f77a4d8b87e6a7fe2a68860f92f57bb19dd3efa476c7603e |
|
MD5 | 1037cc697f5f222a9aa8c5cbb2770032 |
|
BLAKE2b-256 | 041a4e10a52d87c5d1746261b01c75e9136365bde3f6f604c66d87c699d029b6 |