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.582.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89800f3f0c9be415aedaae9df94370455d57b5742697db774250e9d5afb2fa5e |
|
MD5 | 7801c3d8c1546d82daaaabf3acbfdabb |
|
BLAKE2b-256 | 0b4a1ee1ca64a4f02e22c322c207f38989d6cb7c6f82393adeb7230d3bddb2bf |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.582-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5aec158e8b6117a30f72bcd8c7b54d29782e1ec8b5fc5a8d42cd882264c3d481 |
|
MD5 | 3ec121173a11d63129786eb0bdbe7ffb |
|
BLAKE2b-256 | 596becc9ced82a722cccfe13350a2ba981b042be64c10745f8d8b86e783e8e74 |