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
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.931.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c00bf3dc4a765994650f97ef46420b5da76c858311d74ae31fb282e88576431a |
|
| MD5 | c03500806c883825c60e4bfc820ddf81 |
|
| BLAKE2b-256 | 741ae0a048b580e516e4a5e6cd74acb3b9d281b0ff9273bfbc1785fbcdd31c57 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.931-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6189c94d5ff5015634e2dba443c20549acea583ed9c5e44594aad360ff63901d |
|
| MD5 | 7319e4480922f8924efdb53dd1036a94 |
|
| BLAKE2b-256 | f9b24f89f0923d847e7bf6a800d253f5b933bda139cb2270ea8c9756987fb00d |
