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.817.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12ad4a965e9d7b88f069cce5891d22078895a8046381fe354c668eb82eef7239 |
|
MD5 | 38be4ecf5c25d74c0853ba2384fbb9c6 |
|
BLAKE2b-256 | 8db933a036bd93ffe26bf96d7bace0ba6f0ab4c61652f0a7d94bab9821af04b8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.817-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2909869154fd2ebfa4940f370763a58ca99269f58d1441e16e0641119887de06 |
|
MD5 | 49d97845ca424d8c874a1d82f0d6df1f |
|
BLAKE2b-256 | 458cea59b498b26b0812dabd264bd9076c956824b9d1a481ad74ca8b9b4c4943 |