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.589.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c2810a757464c8738c8f14b454a9de1723deddc401f6de441e0074b8df8d1bf |
|
MD5 | 5c09ecad2b9d1c86d80f80cdca77a201 |
|
BLAKE2b-256 | 6b43d1d97ca10210cb5174a9c3a2262211c20c2276217ca65b01fdae6c76ed3f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.589-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ffea31ecd63bcd968d216a49c0a7d9bc4c11a2191569e8c622d21fdb84ebfdc |
|
MD5 | d9ac494c5af7bfc159b5b15bc4a8aafe |
|
BLAKE2b-256 | 0bd5fcc0aee31a8d94f4965e22cb1a8c59c2c4baf971662824ac5650c0d1d884 |