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.252.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b71325503b30e3abce781e096e5dcdd229cc695bee191f1cf534bd53c60fe20 |
|
MD5 | a52376fcb153412b3c48ca7777a43528 |
|
BLAKE2b-256 | 66ae8472f41aca695967f3fe42f40161a812f8c4c62479927ffd4a09d1b6beaf |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.252-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4964d19ca48ed046c3094d901aafc9c580371a86eaf53f1ed7c82af82f5f00a3 |
|
MD5 | 70405683c096f0b0052408da0aa52f57 |
|
BLAKE2b-256 | f3d117631b40b4a4a96c68644caf348a9902ffa25aa87ad0f8afc5fbd91205d3 |