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.142.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2b498540224cc32982540314c7611320089ee267845893b912bd592966ee1e2 |
|
MD5 | 2f96d01da23e85d86c8a074e77c8dc5c |
|
BLAKE2b-256 | 6d0613507cd3f271fc8e460ec82db04518189ef0f2b8dfa2ca651e68a0628db7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.142-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3545649a208c8ee33c50230b5bb820a8d313dfede83e474e69d21f05c915edf7 |
|
MD5 | 190cc13fd2bf45cf87896f34d4400f81 |
|
BLAKE2b-256 | c941905b63203e9d3172b5f7292d2d2d9b574a3f9b81efc38f4900fca695b011 |