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.293.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 483064b220afe93fc74170ab95a6bb5bde565099d49d60c4a5dbc0b74d847980 |
|
MD5 | c5aac0c201e65c14aec3c06729425914 |
|
BLAKE2b-256 | b54d6a276e621378d02c77a45b1555227f8cf790febc31b559dfcb22513c685b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.293-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b5d2669fd65a29226bd85115ae064b61dbd941c485f64a8c53740b1f3e77a65 |
|
MD5 | a4a4b08e7543c9cb3675ed48f80641e3 |
|
BLAKE2b-256 | 23def301d25709385bc0acbee1464c3de7ab6317bce555400d1b5d797d90464f |