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.207.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cce3befd4f500fef3cf538ba922d1e80abb8dade54a477b512de238df9560fb |
|
MD5 | 2718982feb622da55ffab95542d80a19 |
|
BLAKE2b-256 | 99251ad2e26e6af88378ae2304c01429579d42361f66983f91c2fe0568f3d7ab |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.207-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 75217b7616653c12dcae9fd720258966b5fe00fbd1dd58365825c499503123c6 |
|
MD5 | b6491ed713eb9a29f5049c15b9d46560 |
|
BLAKE2b-256 | e593b8109f5e4bbf57372a3feed8a70f44c7439007dcacecaf44e5bb88ab9d21 |