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.204.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce374c5804b900e507967ad6dd032c667dde74ed8b0e0d78f31de132f004c1e4 |
|
MD5 | 0710a34717b585cf0c90db25086aabb7 |
|
BLAKE2b-256 | dffc459f42f5c020f1e1f2105544b4d8f1e783e340f4d22d93f247d691e83808 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.204-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80e240ad70c692a7f3bf86cb3428deb28aa02f56935fbb91466f7e27f89825fd |
|
MD5 | afe004fadf8479ea95bcfee11fdbaf2f |
|
BLAKE2b-256 | 0d38f72d4feb6138c8fbf5b1ec84bf678e756d38188bdff797d052376ed28ee1 |