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.482.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbbba10b8ccb378b410ba1b4f8ab74ba227abc10ca39ce246e2529ba3da374cb |
|
MD5 | 6fbf379205b4f512ad9849235c26349f |
|
BLAKE2b-256 | 7a92d62e1d82c0f20e381bbab573e048aa3f40b6fe97650be741bd651cf22ea9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.482-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84c3d178b30f7c10ef8be71facc6a4e0fe65fba2c9727c76227e97f60e3a6e46 |
|
MD5 | 10ac2d042f554cb0f60bca0cb6e13d82 |
|
BLAKE2b-256 | ea1fbd93f59ed01a08837a1dc1348f62724c85764fa2b7f415c67579d246545e |