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.890.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | be2fb23a1ab9820e2c8a99c81d79122b6aa99a25e3e6079d0273f1755ff05d01 |
|
MD5 | 4fb5a418ec83469b460f798281f5857f |
|
BLAKE2b-256 | c967b0f4cc9b856ebaa2454a7c5e2b4252c3264520812400654bdb8a454269c6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.890-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07b6071bbd9187b95f64388e6e62e70bb75c19596c7f28eb748de5758543227b |
|
MD5 | 5bf8a56d74b2b3dface1e191e09c00e1 |
|
BLAKE2b-256 | fabc478483e1bbfe30dedb9ef95d81c63e1af25e8ab575e733f6643845b02bfa |