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.76.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8725d38f4f0c8c744e2fac64e1160e8f544e17b6e68e18d7d1fd4b5714332e37 |
|
MD5 | 4cc6143cd5739de24450524a8974163f |
|
BLAKE2b-256 | b0bac8e819e6a2fbfeeeafa11f229be4789cf7bcdd200b998a1910a53c628889 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.76-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a1dd4c4c5af6881bdf4fdc7cd0e44eea2b75569ea0dffa25849021ec60f7ef6 |
|
MD5 | e2c4a9882e51c6669bf57fbc6129f094 |
|
BLAKE2b-256 | c3e64d3a174982091e0f84badab3e63dc63d0805639cbe390475afaf8dfd4429 |