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.660.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 619c652fc3912b4469829a33424f24ef64d80414b1810e9ea14c8d73b138503e |
|
MD5 | a88fba48d2131d94b87a15a9227bc9d1 |
|
BLAKE2b-256 | 13c43350f59a212a5b53cd09b47aa55794d3bf1288b99a63dca7958a59c58a89 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.660-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dcbc0d39caf01d7dfb2e84862b5d23154376c0d8c55a07cafd69a17ca5b65874 |
|
MD5 | 1b5bfdf111b27d3a8ee9073f01f2ee26 |
|
BLAKE2b-256 | d89bcf91540e4c09da2b7f95e25016f90f6963c20152ea5ec856c8649f5ee0b8 |