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.327.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f330dfa3c48a4b98d3541316726c744d01adf713825beae6fe075b18cc49a18 |
|
MD5 | 185285cb27bfbcd5e23a913a31cf6ad8 |
|
BLAKE2b-256 | d934a97aef0d88c6f1838bf7d01821870f0d8ca24be3d3fb1e41e4f70c01cd48 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.327-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cf0713308f0469866d542f62a81af46a914db36ca3c39f3b0a380b0bb743da4 |
|
MD5 | 61f2fd27edd510cc247999158d29966d |
|
BLAKE2b-256 | 3d8f7beda4ca30ce00b05383871d1a6fa8aaafdff261652f89b1e9949cb96d15 |