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.164.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 876484fae6dfc6434610a5b4750c0f5b70befa286f449a3bc482fcb2991b9f4e |
|
MD5 | e6327a659892d289125022c388a0b2af |
|
BLAKE2b-256 | 90d6992d8f15cc7e4132ec5ed6574103aabd0a00b70449730330ec5ec9e4edc3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.164-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87845d174a5f841793b9cabd92758c1f8bf729f8a60a368aaef9b10a2722f9f2 |
|
MD5 | 7cb20e720487ef99a14c6b7332c46c54 |
|
BLAKE2b-256 | 0d8ac3eab7b9b16b10a4c8954590b0dc368edb576e5e3b06fe7d8d4ff286abff |