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.345.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1a1db44d0d3ba9861cd2eb970c925eee5a36402f066acd59ccfebd97b56d24c |
|
MD5 | 67d1ee9eedc01470e4ea1fdf9e45104d |
|
BLAKE2b-256 | d43c7250e7cc5c5bdfd8c3ec6ac81d20811bbf9f642e55a96c382b391fda3f09 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.345-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 774e017454076d4699f6743c9ca582f2756d57e295a5142a37a08fdc56bd1539 |
|
MD5 | 7d21cd8b88374c5a4eaeb1663b5e6883 |
|
BLAKE2b-256 | ed645d36198e3b284420d8bed0a0b008b522a25c981fd469319355eeb1a06793 |