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.357.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38b7605532d1c04b00b5c54687803e0fac199cc604edffc45d498e17dc19446b |
|
MD5 | f37a4ad394bfdf7892ae2768252b5609 |
|
BLAKE2b-256 | 611ebbd79157101b735710fb09e568685cb2ae775b40ab8f338fa69ac76aa342 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.357-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f86d47a18674c862c3eb31bada60b7ff8d05100caf2e3fedd1e2a9f5d1cc1107 |
|
MD5 | ccb614a114d59eeea3664481fae5c978 |
|
BLAKE2b-256 | bb077738682151b2d888d5ad57546c8e3431e21d2709ad240058414e0e05aec7 |