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.687.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3930525277bf5c24eff41ebc12bae6c1412ba8f08b5719b2974d348f32cdb8d8 |
|
MD5 | 0bf6342d67b46017c41663f58119d044 |
|
BLAKE2b-256 | 2bcc3b8e72ad6378197cda096c46879385114e6f6f0fb5bad22b7f40b55a277e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.687-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d4ea65d4ef1f118449b764d2d30a026e8285a91b1c686c85aaac9d8e8d5551c |
|
MD5 | 0ffdc125bb33e64f63d0806a45f18610 |
|
BLAKE2b-256 | be9a737b378a730966eb54738924d1db6156bc31e09987f1c57d18d2d1a6cbd6 |