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.436.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aec7c9edb5b807cc802e7fb32552b818c621eb1da67db8d6bba51d2ff54049cb |
|
MD5 | e8e837826e91ff37007b48f836f4adde |
|
BLAKE2b-256 | 5364a0d474ee05ad1086f7cd81ef00b4873af70aaa49f5de1588d588777532e6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.436-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ffa78d0795cdf8e0880f34a59c08e21c0c1ef163229708be9e9c8f60ee72f26 |
|
MD5 | 332972abe4fbc30c9ddf67f5ea9b0ac3 |
|
BLAKE2b-256 | dd3fdb1a841e7be081379402150f57e6ea996ffc4cb7aab255d8da0f8cf3a7b9 |