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.610.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f98ead9f0066353c0c652a095c0e53a467ec2f72bd27950e90c126c93a8e64e |
|
MD5 | 51c9d3091551c86345ee762fd0b35bd7 |
|
BLAKE2b-256 | 33e42245e87ec80756489f2d809191e3c6259c5e5be3ad54e0ca113715f991e6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.610-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdcdd97390dad0e25b35fb630d6bdf4599c5cb7b518b845fc0686ebf57463472 |
|
MD5 | eb05a2e8c859613ccac8c08ce181f374 |
|
BLAKE2b-256 | 95d24d9001ff7b31166875167dc1bb8e82328fc36fffdfa107ea5b0e243d315b |