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.579.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86f4f319d788c0ffa94db2dce71f66fe1ca4ec3c83f29e48e390f95e6cd1e117 |
|
MD5 | 2a5c67856d15dc78bdefa7bac85f7334 |
|
BLAKE2b-256 | f3e9a801db36b54b3545f8c06619b2591cc55e9aca29d912459daf99f6d0d6a2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.579-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd3606522a42e0102f454f58095110a769b21e7ae06ffa0ded628ec04bfcdf8b |
|
MD5 | 668def4ee06d5cd44061c2b128b28ea1 |
|
BLAKE2b-256 | e35198298ee8600bf6c87ca0d3277a280f4eb4bfa6c626bf9a327fe5f63882c3 |