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.495.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8873c0313ade5a10cd77451e148111f2b712959a196fa4084f05674b045f025f |
|
MD5 | 9d6b8e0be809b648e61bd2b199d20464 |
|
BLAKE2b-256 | a7f70b40111671e0d9d8d0a3b6ecc9ffefc5a20bc1f16a60c2988a2eb18bf1dd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.495-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50fb9e205ad0348d3730bb07296c03f80fe0ec44a265bf192bfe7ca8b7cab9e1 |
|
MD5 | b85973b168f157200eebe934eb53d7d5 |
|
BLAKE2b-256 | 94c94357078987d43237b3af8b9aae9e9b48c16c143051d3bc9095e622b9f269 |