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.209.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 232cc4a03ee7445e5a48fa0f39fa5f06a8b6c14786b2af1109a5f54321bd6598 |
|
MD5 | da58182a7dfe7a93db89a404aca6311d |
|
BLAKE2b-256 | b99d31ff62b52630e938fe3373b133970468c67e0274abea742b6e078d887678 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.209-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af3ec893bdbf4a8a5579279966c0ff240cbfbedbfc0dc5f6a1ab76e97ee62094 |
|
MD5 | 7b34db9bdbce8c0ea1f62302854ae065 |
|
BLAKE2b-256 | aa4abee8b9e48458f8ba909618213e29f32633306d4e80e61d4b550caa77b0af |