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.278.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 195597b8f7ef1607fcf4780508a6a50e18cf115a6d8d4980454a82ae46b64b4b |
|
MD5 | 04243c95ca30f066c1865b05ddd2839c |
|
BLAKE2b-256 | d1153aba38db10ce26968d0fde02841e6c76592fbb9a465a520fa2052396b011 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.278-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99e14b22c0f44a8263108bd254cabf471506e1bfdd44aff884c9ed06abe0e06e |
|
MD5 | 7ba37c45883fd1b2cd027165b371dbd5 |
|
BLAKE2b-256 | e829310b1bb2feac4d1d42f793c36ae9c97e08c194cb3e7f0acd5a8204f0b270 |