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.403.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc9bfec80efbd07d0531284e7f178a21794f80e632e148f5819eeec3fd29f855 |
|
MD5 | 92f0d9f8b5ba80c4f9c009cee7ab9229 |
|
BLAKE2b-256 | 0f2f4ad471d174a6f7c6e2c99e23ec8f7ee28d6018de5fe4e86660abbb4d4f24 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.403-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce144fea35b1862939c9347e3d6ebfda46d19d6e0e7bebba2f6a7870383e20aa |
|
MD5 | ab780251082129dd4b9ea11938d3ff9a |
|
BLAKE2b-256 | e672327682bed164097c912c9cd03f4b58c2650fb32e6a95d610de7723c4fe68 |