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.647.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3018b6b7b01b033f3ba2225dcdf2cb24e5d274c1ac5a2c92b4264302a679681 |
|
MD5 | 131f6fd8752c91c1aa52b01c2e209062 |
|
BLAKE2b-256 | 93b1142bda46f94735d6cf248781408a8000becbcd47d1888c1b6db26150fe6e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.647-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2a71064e358d915d8696bcdd78f4f5fb48eeb91e0961da35560f0f41717afb1 |
|
MD5 | f0b01e31f1abf5f7287eb3d19ec8341c |
|
BLAKE2b-256 | 9a13180060f6d1c833c653c73fe712f51e4da49ee64cabacf7266425c28c6b8e |