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.17.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e643625d3ea41390f7737722da12cad38bab64870bbee7a6b65a1ce9799f195c |
|
MD5 | ee9e20f461439c96b01851ed5cddee68 |
|
BLAKE2b-256 | eb10c4212b5a4533a593e8a9ed70f001a372d449af5ad65dc2c344cda229aad8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30a36a77396040911d222cd481feb69747c617e768cf1fd268044cebeba0e234 |
|
MD5 | 729a69b63b7394b40fe7738e69b26bf5 |
|
BLAKE2b-256 | 36042bead0a1953c181d656905294ae8620688e9ed790ff6e29a3e5f8755cf34 |