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.807.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e89572abf2b3c6d858d98337807f6bbc49c4b2d80643687c59044fe1cdbc1ea8 |
|
MD5 | 48277225165cee7c77b87a1548af5dda |
|
BLAKE2b-256 | c9dbb40878fca1d0718a52997bdd106a2e0e09d8ab4ab6c020ba985d970961af |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.807-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f88013934a3abd9bd0296fc0cbf2c2d49490819af9b3b90768256afc7c656c9c |
|
MD5 | 7c3c4012adf465b4839d0cb99e81be1c |
|
BLAKE2b-256 | 7e5e7a7bfa40d47335968626366bfe413e5e30f66179e95e27f4302b4ffc2dd6 |