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.814.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d92a69eae856ac7f56c5992a4f75809faa5f815ab421ee3813f5290ed389fedb |
|
MD5 | 5038ab277bc623aa587a75605c690e85 |
|
BLAKE2b-256 | 0d6c525172522e6c7dd5b6b48d1f77745725de5283ffe3bc135b269e9824c239 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.814-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 141d8672ab216bea1ecad2feb05b5ccea8d539bf4b5f936e61faf63b9dc283d2 |
|
MD5 | 489b0a6ef10e5bea340778d535363545 |
|
BLAKE2b-256 | 4f316594196a7eb35201fc86c69823318cb7bbb0296c7c88df156bb2687e776f |