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.707.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 018e30534da868e9ab49e2d9c5b9e7650e2cb2f799e1ab19f5dce53c347581f1 |
|
MD5 | 5fd33fc7a9462f5cbf40e4889add1c24 |
|
BLAKE2b-256 | b1d9487179b46464c3a16ae3fce9818edf93e545cb0527c7c4e538734cec89a7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.707-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17e353b2bfc348672bb98165c772224a1966eff73cac14f91e7447f479f69beb |
|
MD5 | e2efe92818e940656913dbfe27781d6d |
|
BLAKE2b-256 | 92d785fc83e2d38a04d8a8190f0bad5a31f2e4aff38dc22d56303ecec332066c |