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.624.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0aeb1673b9a93d74a269b678b7841e393ce5689be2b0ab5b5a1700f9490c9a3 |
|
MD5 | 2dcdac033015af54f0b98a5baff410c6 |
|
BLAKE2b-256 | 783e549927e913990f34e714e47f4a9d9f9b0f31b004099327f5f0a4553429fc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.624-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc1f32c5d5b84c9f6e024febe2d11a231e8ab57025a998c64935f6c09cafd61c |
|
MD5 | c5740100ad2ae9ed6faa0a31d902d84d |
|
BLAKE2b-256 | fc0055a2b40864cab0175652c141f0a81265409b327680f6b85ecc89b165abd7 |