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.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd597c4f00c13b5a4cc99588e63f393d1b1e12249a6f75a6cc7b4f4ae5f23de4 |
|
MD5 | 0b8017647a9feafc7925136150de7005 |
|
BLAKE2b-256 | a67d6943109c3432f8b220f51783f5af29c667e3b925a93afcee49ba17a54b84 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40408ee44e9b5eb01e5973199aef4d2f7fc4a81cfe7bab2f24f915c52c409b1a |
|
MD5 | 438cdf9343c3fbe6791e62828e19f6af |
|
BLAKE2b-256 | 83b2ef3647781fd4cdc5a828debd21b77570d8def542107aaf32f9942b48c9d5 |