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.545.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 210a3e81a471db4c933d5c6eef5babd0f67ff4a0099930e130885eabec50bb89 |
|
MD5 | baff95bcf9027c09d10731335cebc2ad |
|
BLAKE2b-256 | 0affa2f6cb3ae61a09f127b70e25ebfafc3ee28e04c9cd187c3a107edab045eb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.545-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c18c64c1fff889fa4c7eade5261c0a5c15c91999d4453dbf4d92f9c082e1126 |
|
MD5 | 1be60a0446798dfb65ecab23fe9b4e11 |
|
BLAKE2b-256 | 70d918f2d980708bb906b989408a9ca98cb05ad4c1ea6299a62e1242b183199c |