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.484.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d61f74cf262092fe07f59f1ce6c7eeb984215b7057d3bf27f9be1e1e370f1b9 |
|
MD5 | 445cf63b21ae3f5ba87a0b519e230d99 |
|
BLAKE2b-256 | 2667cec050c2f53c72a6b6a2ed526d2235c828bbba095dea7b9cd3e7d41bdedb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.484-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84f221f652a7672e7ef2d80aceec5e9cd2369d4b3d8ab0168a9d51b1111c52fa |
|
MD5 | 30cf7a70b61c5ca06ae60ef6661f5c23 |
|
BLAKE2b-256 | 3a67e012a2e20ac0935a27052f98bd327d6af5ea0dff74a8fc41cb0b13b5ba4a |