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.329.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb66977cff6354bfd2acfa2a1054af3ff3e1351dbd9ef32044b95f409b8ea72f |
|
MD5 | cd380acbe4601fb6574b563bc7e96b26 |
|
BLAKE2b-256 | 7a756cceffe4cff7800d88caaa9705701b6ec0e4929a99b1a2456688d3cbc2ac |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.329-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c993dd0895813303682f5cebaa68f282c8bf05998d001d2c2bc98fba258618a |
|
MD5 | a67b72855d1b2728f1334c1b34d186cd |
|
BLAKE2b-256 | 0a84744f6a7a565d26b38a4f7e644b215dc9542e174c7a2746388e2f984dfe3f |