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.412.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a8af52df5a29f1c35626568f28d635982c0cb37c7d08f6067b77ea0d4c766d6 |
|
MD5 | ce330371f337712cc79a19ecae83b390 |
|
BLAKE2b-256 | ad3304c45c43a3120b495a1a4a8369689271348b7a6250a5031eab00d468e49c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.412-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e51caac0ece3b4b9c43613dbed2a628a9ebd367b82a6c3e2f301bc5071df4bc |
|
MD5 | 687fa4f957dad199b5c5aff774b4eb9b |
|
BLAKE2b-256 | 5c36f5952080e39f8069fa6b1ebc2e87aab4637b9bca809e55aa302f96e0124b |