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.128.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6979f5375679ce14f21198fd17b7a957a0b1e5626341884f2a2426fb5b0be4c6 |
|
MD5 | d1009b3f60bbf9d9ccf74779aa55f057 |
|
BLAKE2b-256 | 159a8097a4b630af11c5c62b3147485c81186c4f6a514947dadcaa900960dce8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.128-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a30266f256b84b636d353da1a5c8159f82434c887653e47a18ba7efb82c17a1b |
|
MD5 | eb4771e880fad77f37758707c91eac3e |
|
BLAKE2b-256 | 3545f15c0885f56eda6a84f389bbafa8e73099eb2f06f067ef8514b5ea71e8c8 |