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.601.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 246880c1c6fb5ced9ab61d9a9be2b47122f46eb5243e2c5056b5c58f9dfde9d2 |
|
MD5 | 8bc4038f2d717d94b450a3a28daf0153 |
|
BLAKE2b-256 | 6d5a1ceeeb5a466deac1c4bd6a0140e1523cac3dea45ce92144f3e31fb064e11 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.601-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff125f0f70263de553b67621eca19721d2bc4e5781bf7d49cd956d466fafaf7e |
|
MD5 | b4f98c188cb8530f94f0f96e758da329 |
|
BLAKE2b-256 | a559361e4f601953c416e7ce7d2659e96b88b35b52d47a022b3c6d7e76a42012 |