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.921.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb0ade3aadb8feec3e4b39ebc615b31e09a0708d5825cb3cbe94a422063480f6 |
|
MD5 | f332610d3eeac47d04737846ff4dd34b |
|
BLAKE2b-256 | 37922f9dee3fd4a4879da185883d62ca1f5600deaa0a229f76addfcf464608c1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.921-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ed73313149ccf1108f54b4071bf7290f30fa1bb95e430d8e82c2660baec0683 |
|
MD5 | 73d8df63e10b61bdbb7bbd51bbd30b37 |
|
BLAKE2b-256 | 439185c2b683d1dedcc7e137747a9557e55777bf03c5be694eb725a75ec0f0d8 |