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.231.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf8b093026602f662f6d6529d36a82228011a56a62d8f475c189cbdaedeef442 |
|
MD5 | 2f9636484293bd7641ec48976a3602c3 |
|
BLAKE2b-256 | ac1e412173a4223bd5587537689a059283dff22c734f84e8beed210ab34653b1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.231-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 317f2b1f9231bbd9d038026cb950dcd626e8e0cc3133b356a7875bd966a927a4 |
|
MD5 | e552c53d8bcc0aacb7917c9d8fe3d736 |
|
BLAKE2b-256 | 17af1b8e8f166d2d75ce08d2b0f33829607b2351f2dd6ce3f4e15f9dead877d8 |