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.530.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e09348bb3d36b8c7fe194b1453629a1f0796525f79ff488f49cfe2d1c0f507d |
|
MD5 | 26f42b96d26427eeafd56fabe1bc3f83 |
|
BLAKE2b-256 | 941835f467bdf32b1f44048dce501d0614b758802d8d9aebfcd812d547c5de4d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.530-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06ab22a591054324a109045b20a4860059c269e173f482be253ef73d00d112da |
|
MD5 | ba3a44ef4d075e508401812766163e6a |
|
BLAKE2b-256 | c79a4684c96230c2ae6dc926dc9bcd9e4564670ee0565d442610ae7791d14f89 |