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.52.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4bb2c68b4b3ffc1718c4e6f26955fcc33deae9fb617528c4146716e888a5ad2 |
|
MD5 | 6ddb774e27197739a92c0d04f2757cd6 |
|
BLAKE2b-256 | 3a51eb7381b20a76f2a7c8c6b16462af56aa58f478e7fd3d0419068be6580385 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.52-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aac7eaf9efd2c39d616a12ff9c295fff6808d40a7f9b226c386ffc9bc7580e4 |
|
MD5 | 34137dfef9e6d930a30bf9c9574063ac |
|
BLAKE2b-256 | 6618ccf589e19918fe6a5fdba946cf3b5472ce1ad2acbf3707ed8960568ce6d7 |