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.215.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b052fbc82c9cad8d64d1331cda517a258a3b29d9dee24219acef58fd88b658e8 |
|
MD5 | 0e605148f4729132a59efd8b217729e2 |
|
BLAKE2b-256 | 3216138c2fb8f6cd84df11002b8f98468fd9944ef2c6d0d1b851d8c049171909 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.215-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a462dcc9b05d619dd1b4bc3bdf9174b9c102f91894547e291941c50425b2b43 |
|
MD5 | 1b263f0bbf3eaec5b12a90d15ea51a80 |
|
BLAKE2b-256 | 12cd77d4abddffaf263f97944857e68a776164af9e2062d92ecfaf756e78341c |