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.609.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa017c61a84f1d222d44fa25c879893ba90c2e6fd64a0302e9ed3e918766612f |
|
MD5 | fe760d83109093260fce033b2db6c047 |
|
BLAKE2b-256 | 47169bc0080cb72392de3c8fd1195e00c38da0fd388311c423c91777b44dfad5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.609-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a459cbca2be3b6ce7ef6d99384815f69b8bbd20f55711c87b0bc37eaffe6221f |
|
MD5 | 0b8c2db968cc031bbdba3cc5e48220cb |
|
BLAKE2b-256 | 2360fd0afbdca0961ada68a495c4bc690bd1760e268161403787d260985d4c40 |