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.748.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8fed4ce627cb3399422f0b624cead4a810706ce42f0452a38057b2d3524f0d6 |
|
MD5 | dd055b7f478d5f1ee22fc75a34707de9 |
|
BLAKE2b-256 | 9a4e949ba35fcb5ba7decdf2dced4ea9fa70251fa393338d2f73e414c8d0063f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.748-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2117daacf174e5ef9a2b15648af9acd2299910015f61eaea461cdde24a0c80ba |
|
MD5 | 656f9ad35a2ad8104e2a2abc9cbccc9f |
|
BLAKE2b-256 | efa9a86618a192e0deaed4df46d43c39f42c05c052695fe87cf2d2e528acff37 |