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.392.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 960d52c643381ee69c58fd3290fdd7437b5a3b2b35160a721f28d6addd01d867 |
|
MD5 | a4dc736804bb15404737e9b48f0ba8f3 |
|
BLAKE2b-256 | 041c3dfd25d3cbc49fbb7b3aa409803b0524842b888ba56527a4fa90f27b0fbd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.392-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6687be58136b6b4c0de7917c46fc59ae7163ae6d711eb28aca062406e4145718 |
|
MD5 | 0a01273815119d7f96b065c3652596ca |
|
BLAKE2b-256 | e96a27b4f2dd54f061fca647d9304a389a587b9deb8da37a86584d0912a49270 |