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.290.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 625edc9583d0862cd383e125941762ccce448c35fd261f87cb4eeccc2a17d62f |
|
MD5 | 610664a4ad3b219579eaa2be23c38f81 |
|
BLAKE2b-256 | 4e3f6bd2ebc3606e15b5c65ac78ea206b8fc4a09171634f9aa1e34cea8363e3c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.290-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1115784cc9b4ff00e37e86ae2001652cdcc70600480b15793c33387490db247d |
|
MD5 | 771062eef2978dc6dc3bab639dcf9619 |
|
BLAKE2b-256 | 73b25c3b6543c1ce1fe6aede1944b23833483ea5c3862482b731feb6c09eb03a |