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.773.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35d18934277a4806160637905a32dfc9c2ba28db6c3eeca2e6e962fea56864af |
|
MD5 | 459df245140d9a3d1f352a1806a995e9 |
|
BLAKE2b-256 | 0b01996230ec96bfaa40184c8f5124901524ced52d37b6f39a3015a14343e563 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.773-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91f1695b322e0bd57210bd2021cd7e20efe09b562ea020dd36dc3c71c9f3fec2 |
|
MD5 | 71d5f7e50f579ebd2282794bc9bfdd52 |
|
BLAKE2b-256 | b567eb42ac146d91a490502ccf27ca8f1ffa4179e8823422ddf48bd0c7ed17f0 |