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.642.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e727fff5a96a46e52c95ee7fb12a6d29aa66b786dc208a489c46394a60765d0d |
|
MD5 | 36751a224ee7a5856c823638dba478a5 |
|
BLAKE2b-256 | b01a590a00f8e16fdd04cd14bd24c77bc31035d08fd84b7529d73b3921562439 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.642-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7375f395538864a056e318f1e5fbde1f4afa4105ef8e46507f57f6a887f5721 |
|
MD5 | 0a59c42f4265e5117bfe16b86939ecb7 |
|
BLAKE2b-256 | b9f3595d2583571ed04d5ba125b0053c413d94874e43a8dd296c76c499050e66 |