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.781.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b777f3a69576a24d872933bbfef42875d3276697ee9743c05e71e9939966169 |
|
MD5 | a726b7131c89a5e84f48e3c7de551846 |
|
BLAKE2b-256 | a9ddc9530f5f287bd162bae028b2e9b28320f4e7fc75b18a898549dcb9fbfba7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.781-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 774a8b849260fdde5b336947d22de0bd8735f9ce831c1939a69ea6f19710ec85 |
|
MD5 | 16f5f0d2c339cfb9a23670abdeaef347 |
|
BLAKE2b-256 | aafaa9de9a3c53569af1883e579e1a276d1213c40c25ad2a5cdd73adc94b5f77 |