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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 259cec86599395835a66d6ae67f8f537f799edf1c6f9802e2c2d9f961b218e3e |
|
MD5 | 2443c6108b3008d5fd0c275f07a71994 |
|
BLAKE2b-256 | 2644cfb41bb91eb4a3da6064a203ad16cb3056dcc7abeae89a301f9a4e4259f0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10c6753b0c2fd0e3e447065d2368b04259cf16b3b47b1ba3325daa1005b2d372 |
|
MD5 | 43e8684cf6502e9aa2cee675cfc5d75b |
|
BLAKE2b-256 | c2e2be0ecb78ea2122fe338e5a1a3f8f3109094b8dc0f677017c72c995f768d1 |