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.822.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 964ae88cef44eae40d021f05dcf26237cc157b38da56209d695037ba43a3f961 |
|
MD5 | f1ed32b2f2f7ee5a9ab2728e1178d83c |
|
BLAKE2b-256 | c641fbe76e08cfd0c6bb8a9654d1580923054939a1ddf37cbecd6044f89c4cbe |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.822-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a62f7c0846c544b2765137de972c65bd7c6f0c15f28c2b9d1eb5302ea093885c |
|
MD5 | 52659102779f17c4174047161468fa2a |
|
BLAKE2b-256 | 7926dbe1f36866858d9ed4efcebac60b968048244ec145c825a22526d12d7b21 |