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.849.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0d8d4d837d6f136259ff3050f781d035d848c17095b3418bfb7b6c4b679a1af |
|
MD5 | b1488f51a66d5f46d912c22174575090 |
|
BLAKE2b-256 | 520027af47a3c17638ab5d70f7de8f087b9c8ae70f0a0f8a5846073f47dc0fcd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.849-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fddf77581a7eb4fb19065d3904ca51d22ac8a1e9007de8455492e6d3e4522a4e |
|
MD5 | faa4950bd628a648e992daa02e756a84 |
|
BLAKE2b-256 | bf972f4c2044bdd1e1d565aff8ef0525927c2150b30e8bd42aac8e0cc561a59b |