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.667.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dbc9662e9c580595e62e7160a86bf0d0bbfb4f473d0dfbe20168548bf6d43ca |
|
MD5 | 74c616caeef24d35d082e1ce9cf0923d |
|
BLAKE2b-256 | 70ce84e4aad9e639560b04ae890102ab3729f4b6eee0ec83c6abdf8273d5a192 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.667-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f213d8f1eb498e27ec2ba5aa229fd6346bd054518fea3169dffb3ffce235cc33 |
|
MD5 | 57803903dc8d8f5bdeb2b8dfc725acc4 |
|
BLAKE2b-256 | 37208fc6e51eba2c8defc624516c7c8322a9ee1d46718031cd2d276402c1cb6e |