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.860.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f3cd76718efe693378feaca46535acd39361ce414bedfa7f740b59e0b6daf49 |
|
MD5 | 829e2ad085caec339cea2d2b5bf80bfb |
|
BLAKE2b-256 | 182209d84a604fe112d2073071eb8bb2859f7b9d53513f87ca522a77e9014bd2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.860-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4057f23c1810a9f5c51f89b62e0e461b03f547da9bd61ad55b863612d395515 |
|
MD5 | 982481c583518a75df1f34f5982d4bb1 |
|
BLAKE2b-256 | 208b427144bee730f840fded4345bdc342af0e4b70b74ca8f08b68efcbe09ad8 |