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.279.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbcac05e8fa640b8dd656b3a1c233018907cff0206992bfdab91284db55a8034 |
|
MD5 | c18a604e3855a4af5b9cba142ce1bc62 |
|
BLAKE2b-256 | 35c2a4b3d1c2ba98e2557145386e25094cc988317e23f61474a61d869defe5fa |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.279-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20860d0d761be0ba5778b51d875799ac35d80ba35b6739c933c9309bb7a15486 |
|
MD5 | 828c0e9e91489f6a1fcb94f4cddff1ac |
|
BLAKE2b-256 | e057eab6e56acf35888da5451bdf4f28c16252efa8fd5dc67320d687366080b6 |