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.734.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67914cc331b0152b89a4c79dca7c7419eb80e16f2eafb1e1f29d1e161c1a23d9 |
|
MD5 | b0ac1ffee88d5fdd3bebf1f6c08704ff |
|
BLAKE2b-256 | 9aa120f907c7161fdd420e7e7a3fc3f99e6bad6bae0b9c52ca2fed873d6e2d6b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.734-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d98e3548fd1445fd333c913f75b112ebb6efc99f2a5a4ae7d9f2de75222be13f |
|
MD5 | ea17dee85709cce75f3944239362f81d |
|
BLAKE2b-256 | 40b5978fbe64d88a4e73096f9b6f2021e7c6c4b6e1352ecb3a5e8ad5763282aa |