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.314.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cadd91af03892074b13cf8306590f3fd3e59fa90ec31fa83cf15195a81a82906 |
|
MD5 | 03e8aec522e00af58774f956856cfe67 |
|
BLAKE2b-256 | c37190b0f4f3f190229af6559e6d28e8c111a856a899d9cd06b57eb1e1f56796 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.314-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89f6dc416bd769684e3fb181c61bece213e64600c3314b609cbd4ff23e411146 |
|
MD5 | eb40eb54b4f8b1078cbd0d279160d156 |
|
BLAKE2b-256 | e07d4d441cf04b8d73b7e72cf4d39af5603faa0f7780dfcc98b7a4bb28ed7bb4 |