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.48.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4daebe9dc45652aaddd1ee299feb102b5945b99cfe1beed217c685c645f7fe4 |
|
MD5 | 56b62ac832f0e595f5c3b43bbb5d1171 |
|
BLAKE2b-256 | 29843b811a46e7d712964117fc31a6b3c42fbbf35a3913beba45950dd707905b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.48-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 473ae68ad86786fcb0df62e6059c0aebe27d92d4369704419cbc70e043174801 |
|
MD5 | c3790f7de9dda652177a8e324f5e2024 |
|
BLAKE2b-256 | 88593d7d5cbf6957d7613dc31efa772d223f78369e12e17d5903bb1459eae442 |