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.792.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77266ed4042b4e7333afc3191b29145964483d2bc3920ea914bc44351fa20116 |
|
MD5 | a11073e3c829b0bd1151d666eb3a016e |
|
BLAKE2b-256 | 570477d7adf4f29a1c255ab2b667f1d170589563271baea053aecf6e7ee51517 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.792-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51030a25d1e7a523772d583699e5378d6f1f12594d216f68033a5f2b1aa18811 |
|
MD5 | eebdd733399320e892a606f5742ecd9b |
|
BLAKE2b-256 | be41ec6f8fe620959ef22699d95592cd7a3b424c4cc40fa7936e4be28d25c82d |