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.634.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45900f2cc232ed463d28fbda5330e40cd5ef412a41af79e7f8a50a0e7119fdc9 |
|
MD5 | 939cb9efe6e44cadb4e38949ef7a01bf |
|
BLAKE2b-256 | 58c15eda8fa6d2cdce3c371d599a36c880ba6e4edb080676985943f2cf149289 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.634-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3319030cf8c30f9a422cb8e7bad059106744d6eff1d2a8fce6457d5c83a19034 |
|
MD5 | 256887325c4a3240952c4a410c92d612 |
|
BLAKE2b-256 | 1a4d5ac1a24fb37d6e430828231adaedbcf46f1ae6623b6f295d36aa3ac5b4d0 |