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.33.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5152789e04db5836969726c3bc26ebb21868218885b67f87d4fcdca1afab7a5b |
|
MD5 | 7df10479a450a3e4641ac6d887a4768a |
|
BLAKE2b-256 | 8bd78732febf076f566b20c16d7440ca04a76a98334b16cbb13056185b14a7fa |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.33-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb88008849b05a82ab7387eaa766415dd5475a83d017030c5244bf4914786170 |
|
MD5 | a4e518a7cabf0e7294633b161dd429f4 |
|
BLAKE2b-256 | f5dfd6461fa6783962567a9f9afa713fd63db9696f7eaab0ee784c0745cfd524 |