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.172.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a6aa779dce7a047f3e8a9449483dedbdf37bbf677771f66a1714af9f2aba46c |
|
MD5 | 6845c43e8a15a818dd1d5f66884651fa |
|
BLAKE2b-256 | c8da38f3d5da94bec07f4214dcee2c04ab2a1ad5a986fd99484ba604ccaae793 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.172-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11262bfa940ae4248b571092432d07fdbb97e4af9839adeeb381fe3170e79187 |
|
MD5 | 3d9214a4e47db0ae73d9a44e2b8ae719 |
|
BLAKE2b-256 | ef085198c85610211fe1f7dabbdebd475362517411d37243086bc1df6a01b681 |