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.528.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ea245bf811ef8714af4dafb2e8ff6899f84f699bb8821364e3340725d06c15a |
|
MD5 | e71f6e2b5a9783658c05986e99e06ecc |
|
BLAKE2b-256 | 1c79853bdeabf6876c39bbab775ff0814cbe52801f2815e8132c1d5c6001788b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.528-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b331255e0d015f8ad9370a0ce7c9fffc710bf9b30b2a317d5bd55d2b708bada2 |
|
MD5 | 61216b43a92f79eb37ba93aa7ec9feec |
|
BLAKE2b-256 | 5f16cde64906c92c738380039e900770bc13b55f029ff1b98a86843565dc399b |