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.487.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a8d359834faef88ed3b3890574cb87ffa0c6eff1284d378807887b7395ff35a |
|
MD5 | 74a3bb13aaa9d0c585b4f8086fd6ab18 |
|
BLAKE2b-256 | 53a7fa5c2f75cc7865c70af985328231659c50b869b607e0c80eda4493f97ec1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.487-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f15c3a75189e939aff976d0a9df46cbb848d3e2d5edb68e684f1b20b884185b8 |
|
MD5 | 3b633a1932b2673220cce782d4dcccb6 |
|
BLAKE2b-256 | 5c29b62acfa995f61eb6d4fe022ffa490c75944e2a4a93e0adc2b54108e666f5 |