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.441.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a81fe5f422f327c9e8dd25c222adf6c3d3eaf95527435a756a6b3b8342ff6e3a |
|
MD5 | ad8135ffd10ae9b49585c31e5821ec1d |
|
BLAKE2b-256 | b224bc3cd24e611546273fddca9e158229f6d14924e8c36c499fe72afa04283b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.441-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a95824023141f397a2106febb16a0eb17604b30104797a6e7e69ac7b8e36b72 |
|
MD5 | 71d5e205085b278117f8bc686d4c3980 |
|
BLAKE2b-256 | ae26aad9f1e4f5dd64333968b94da3b7863b1424e72a5551c05552330217ae14 |