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.171.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fac5eaf119032a284d9603e83d7a20cd5f460bff8e70b04ae932e97a0e5656c6 |
|
MD5 | 98bc294f4506982fa6168fd6b2c431f9 |
|
BLAKE2b-256 | 24ad49bca349bb14f2e8b8e124c19c88aa2fd27f363e007452215dc3ee539da6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.171-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f28ca9ef591c9d93d29f0f31dee058e38913056417e6265a9248b3adb93c3bb0 |
|
MD5 | a3040745c7d689a868adfeeeece12f34 |
|
BLAKE2b-256 | 1c5abbe052a59d5c906f2f35edb889f71029eba4460354779d2fdb5af0de72e1 |