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
Metadata
Release files for pepperize.cdk-apigateway-swagger-ui 0.0.1274
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pepperize_cdk_apigateway_swagger_ui-0.0.1274.tar.gz | 5.4 MB | Without provenance | Details for pepperize_cdk_apigateway_swagger_ui-0.0.1274.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pepperize_cdk_apigateway_swagger_ui-0.0.1274-py3-none-any.whl | Python 3 | none | any | Details for pepperize_cdk_apigateway_swagger_ui-0.0.1274-py3-none-any.whl |
Total release size: 10.8 MB
Release files / pepperize_cdk_apigateway_swagger_ui-0.0.1274.tar.gz
| Download URL | pepperize_cdk_apigateway_swagger_ui-0.0.1274.tar.gz |
|---|---|
| Size | 5.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
178f554719874418df49ff244e96b359d511b916fd7b3572556b37bf726e8fa0
|
|
BLAKE2b-256 checksum How to use checksums |
410a3f54f20fe66e69fc920140fa060061d1ac714ecdf686c1fe5d4e8dd1d21a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.3
|
Release files / pepperize_cdk_apigateway_swagger_ui-0.0.1274-py3-none-any.whl
| Download URL | pepperize_cdk_apigateway_swagger_ui-0.0.1274-py3-none-any.whl |
|---|---|
| Size | 5.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de8234b97e64ad7a4884a50bcc4b5c0d4c5d7818f2e1433671c197ca2d62890c
|
|
BLAKE2b-256 checksum How to use checksums |
acc714421ae0591e486ad4aed74c00800bddf236ef19ababd7e59848f4e209e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.3
|
Security for pepperize.cdk-apigateway-swagger-ui 0.0.1274
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.