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.668.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9e8f5e7368034cd216ee30f64d7efe3184da2d52096906eda9ebae4305f2243 |
|
MD5 | fbca691d6d819877b486f1db25eaedcc |
|
BLAKE2b-256 | f11607bc207f76414e8a3c1b4ad2e2eb02c541c1ed1ae5efe523ec7759c96a7b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.668-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edbce250df2e3932095fdf27e75236146b30e54eb898be04b96a1f48a6acfb4e |
|
MD5 | 93f7f3dd659ca4241cb9f71705f9ea46 |
|
BLAKE2b-256 | c46706c6a347521290559a1dfbd9de19f84a0e0ad052829bb6281f4a119cce0f |