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.271.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7805248b39e5b53f20c2bd7ee47098c747814063b036c3e8bb3a7583dca6ce2 |
|
MD5 | 13e579f0fc1e8d189c3fb5a332fcc512 |
|
BLAKE2b-256 | a31e346c46d22646a50f44dca84725929383d787a88e7cab206ae4758aa17036 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.271-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6956283bbfc62cd87b118cfecd19d69a3d429a32c5ccad6b1492739aa0ad8de |
|
MD5 | 138e4a8007d77c445162965138ee4411 |
|
BLAKE2b-256 | 565bd8bbae79c400f55e52683d03348b22cd72f82a41e0c99ba00c88d8ffac45 |