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.753.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61a42857109903296b1604518b3fb3810e8d88ccb04682609c08f0973dc46475 |
|
MD5 | 8ec3ac179c7490339629cccaf774f121 |
|
BLAKE2b-256 | 8dbe46373c4dcaafa76b28d0ede67ef11f6104b4e9daac77a9958ed273afa2ae |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.753-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edd05541a6af320ba74665c43b2795f41570af631c2c730c0d9c97eb123bb924 |
|
MD5 | 08f16ca2fad121fc5ca3cf6fc9412c94 |
|
BLAKE2b-256 | 1552ed84af94614778c262259bbba8a2e4e828f6bc84b51042f93ca5f50a9c20 |