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.54.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33a9d32236b887c97deb1f339780bcde6d1b3c52cc80adf998504ce9eb1e82f6 |
|
MD5 | 3baa83f366d7cd52175c30c0b41d49a7 |
|
BLAKE2b-256 | 5ace6449587876a88a6f206f4bf6036e4c16b370b980c35183e2ea1c2009df34 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.54-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 737c563a7ac3a7bf16740e2f4f1e88597473dcc1d03fdd4da110cdd2463f0573 |
|
MD5 | 6c4adfa2224ba6b6524c19c519320f20 |
|
BLAKE2b-256 | 1e9c0ce152d54262ede7ae577b4d9de9716f234372912b14835a189617c2a71e |