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.297.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2310f83a4d10f04858a1f1ce0ceac212a794f405f58b1a24fcd0116feb94c822 |
|
MD5 | 5730653548d6fa4a8ee5661e454bc0d7 |
|
BLAKE2b-256 | aa033c09a2e8712cf5ce93e14f905e6b47eef1d0f301c3e1370d3b6d1843478f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.297-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb95c9e7feb17233710930ffeded2bb592875ffdfadcc96e4dfe06937a3dfdbd |
|
MD5 | 04a40b1d387a7a362a7587dc02a73244 |
|
BLAKE2b-256 | 9bc1e3bd99f26dc89d7b87d0509be479892aa1e27ae3afc5d42173cb483d01d9 |