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.548.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0a2dc31c57aa8aa09530664720e1d860d90181c1e0e13f024ae10f03680a9e7 |
|
MD5 | c26c6516b3d88dc01170b33f6c403ddb |
|
BLAKE2b-256 | 77bef595e36e7ef6c048bf876f82f4f46e0e9a50b5c25c43a8086ee540978d25 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.548-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be858c66704ee9e21068e1f754d327185b2b8bdc18e4c1087b65f66ab021a734 |
|
MD5 | 5d01af3c0face6471fa1f40609f5cac1 |
|
BLAKE2b-256 | 67e3ea7403e8381351fc29e73e9db048bec5b2f5fda3b479597a5db0b9cfb217 |