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.343.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9625649e224d7dbb205016fcba1a87cf1339ddaa54b63b57f035a85fd60b381 |
|
MD5 | 06723b08260ac124b440f58693b7caec |
|
BLAKE2b-256 | 8bd2be373e38b40298a8bdc08ab557da17ad02153ff918a6be92cf3e239c2254 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.343-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45d0c0cd5a06552d4bec6be699f4ea3d47656e2ef97c14271adb54b9deb9274a |
|
MD5 | f2a7915401f9519ff8f2b95dced9e951 |
|
BLAKE2b-256 | 1cc984a1689d068806f5be4af11790eea76a04383519e459930696018fc8e86d |