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.689.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96600aaff015b1abedf96c60ba0da8005c41df2a4e4f000e813131252b5ccb5c |
|
MD5 | 9fb8684b5fa35e5b5f93ed5c46891822 |
|
BLAKE2b-256 | bad9167d2be4514493ee6b5dd03a53722c342685de3172d44915353081532793 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.689-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a422978eba7651a95d8f72619fd4937c1c30672d71624087cb08348daa30765 |
|
MD5 | b1a60bcfcd13d300c77aa07b5a5cef70 |
|
BLAKE2b-256 | d37645c2de615ef6a0cc512d07a4413b8efb39581cadff7288e7e62f81c87216 |