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.44.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c9dacc0842033544682e2cad5c77664932bfc6e234141b311d6d60df2005821 |
|
MD5 | 797430bea10abb7085246af5ccdefe06 |
|
BLAKE2b-256 | bae1c7dc08abd75d6b3f29eb73ed35e93bc64db332a831bf7f4ebc0ef5b0b9ca |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.44-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc508727780c10d133f9ef7091882fcd121ba95c500fced301d3ec9955bb0e38 |
|
MD5 | c2cc07f6be22365bb81f2a10b0189390 |
|
BLAKE2b-256 | 6630df42dc781d14b42482f7b5c35fba9ec610f928c74b41e9c00e038b808875 |