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.137.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 741d49b945b6bac3cc88497220e605d6b4797e6ee208ec22ef5a18e0f8095260 |
|
MD5 | 92c27c802e929d240a81e4f8eac41f9a |
|
BLAKE2b-256 | 2040da1cd38bfab109ed25ffab20f417f6b29d2253ddf7def466848d8501ec82 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.137-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cdf20a213e079639dc8669f57659f2130a227c9f62a1f06f703f496f448f619 |
|
MD5 | cd30f0754cbbdecf5c11b7c907a2140e |
|
BLAKE2b-256 | 888c1d90b41d8c1cab80eb68c1aeaaa320f1d29c8bcda2861fda5d508cf3a18f |