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.797.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a00586744cb5d2b94729b9eb7622f2aa414371e2e9a1d96effc75cc77477fbb7 |
|
MD5 | 7c2b541d9d12b77b68c3e4aa7ba352b9 |
|
BLAKE2b-256 | 5324ee2779de274fdb6c082e85cd8e1a68f183770586dea2d2f4da88bd8a87c0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.797-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82f6e6be929622bab06182efd5353b6f5cbb301494b94f75af2ca38261481de9 |
|
MD5 | 2aded5544e0be780342c0ad2ac91fcd0 |
|
BLAKE2b-256 | cfd6f8c87f12f421d5e1b71573e4db197aa9effd87e86f1adc114d6e0c5041dc |