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.565.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94a84501bbc16c8fa88edab2353557d170f776537d39090793c28c73b1c152ac |
|
MD5 | cade3d9e122c2efe8ff62aefe8736248 |
|
BLAKE2b-256 | 7135be7ea2a2a14f5a0edf6a8d1aa92672eb22e4f02090070cddba33afd8b791 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.565-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 629c56f17cfd3fdece81dd932c9bbead5620262cfbc98827b2684beb96f1d3c7 |
|
MD5 | 815ae3fabf0a77a1845856fc9a29bdc5 |
|
BLAKE2b-256 | 8c40bbe34ec00517474b475ddaa60e9267423da4e6de26254f64dfe493c3ea47 |