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.866.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d17d035c18dfe12cb7a974511e907f020ba92774adfbbebe3230d746e6b45155 |
|
MD5 | 778fd3dbac8bf063ce62e3336427ad88 |
|
BLAKE2b-256 | 967e2f9e10c605ebf324befd7fe9f5ea77e34a9dd7a9023d35f00c49b85dec6c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.866-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9f9efbfeefefdb8dd84546146ac5f34bfcee0296f8c6172009c1b088792ea89 |
|
MD5 | 0ac1add67246d3795951dfeb35bc1664 |
|
BLAKE2b-256 | fcd8a9c302a663d3ab60c1deb952824739980399ad22d8c6d63ec2e12cb1362f |