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.853.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fde7aa400650454468022978cb1ea6c4921634e95dbe7a2cbb1f595c9fbc78a |
|
MD5 | ea2f9221c1ff50f8396bfbcb86db9dab |
|
BLAKE2b-256 | a9377f5840185dc8ccfd9acc4f14992dca64d97d6c969a98df9e8cff34263938 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.853-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 206ef1fdbe0ad7f38ff90d7980c4341337380517f1e71930650cb1e6789f86dd |
|
MD5 | 32f0dbc12c6b32a242437e66aa74416f |
|
BLAKE2b-256 | 33d3e1d5e6aeaf2e92c2c453f2f8deea336cbae91d55068d0c2ad6885e748ac0 |