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.442.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef4d8a5b7577d47c276178f100c41d87c413bd941193a42e252d059d174501be |
|
MD5 | 35f60e308e6417e9fc5a9db9047f0b9e |
|
BLAKE2b-256 | 8ef5b569ff6fe761c346cfe6c4f1e04623749b07c65723589a9736167c3eb8d6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.442-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54e764a7b3b059f5a12c1a28c495c7a1841aa1a76a656cf9410f3aeb741bb473 |
|
MD5 | 197397fe5ed13291662ecc5661884199 |
|
BLAKE2b-256 | 53799b80440ebbc160b09f9e221ebdcb0fdc5586564fbd532d23d00c0f4d2f99 |