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.348.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb5d92b31942e6794f65aef579ebdbb2ca756db4a0d28b1c183dd8f7536c2753 |
|
MD5 | 073b6a58de09d29555427c4c6276f4f4 |
|
BLAKE2b-256 | fe559d5dd1b52f2c1766025096ee6bcddad1603fd94b3628bca7ff8f29fca03f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.348-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93ac74943203a306f8ddf969b4b3eb206701b76693e687c8d08cbf1ca25b09b9 |
|
MD5 | 53c7c1b7e784de3cd0eb59894f64854d |
|
BLAKE2b-256 | 57a0d0bc91be7a7b9ccadf7c1c486dfcc1e15d4346ac793a2f029e604436f5b3 |