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.152.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e8e72b215fe661441db965addb4e819d99f774b68d0d5f5516e83415661c3d6 |
|
MD5 | 3284c858b904bfb2f40a30754d3ef627 |
|
BLAKE2b-256 | b4167b057930071e32fdf103268a4ad592ac2b9a9b373ebee5d92b23a507c962 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.152-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20314a6bb335f29a5214a6cd518b3e12f1b4b7618524cf8134920636a93e76f0 |
|
MD5 | 4b47ae594cbe6086dc9f5eb07af96ad1 |
|
BLAKE2b-256 | 5e1f13fb2b49d8f248002050261a1a01eba2191af6de069ebb25f363a4f01b11 |