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.429.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef7f0f0336fd78b2b4a5d54dc803ea22283c2dd4348d68468c1f2c5a7f631496 |
|
MD5 | 8c402431f94408d468eeddf331359f82 |
|
BLAKE2b-256 | 9d57e3e53ceafe7c4712adb1724044398107b3479875eb7a9c0aac554138f923 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.429-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3dc2d56a7f0c1935efbb43a23d9f1cd12a4998cf97bf250f75a2ad994d93537 |
|
MD5 | 9b113f8f923b9b9d462ec91065126740 |
|
BLAKE2b-256 | 897ca67f9c2cf64171dadc18b015b4e47f33e26dc3dc51a35149e783a904f4da |