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.662.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ff5b4182284df5681419a221a124d2ded3923394475c51c2e33a84a3d481a90 |
|
MD5 | c78497979007339e9304b982d6862b31 |
|
BLAKE2b-256 | 4fd2b5f0b41267247ba5afdaaa17659214096465cce8f2c7644afc7b07818292 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.662-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9d8badfb9b97a588317da2784e2ae6a722bdfd15cff67a2fb04c4a10088c537 |
|
MD5 | 6ff8435e4259fb506245027749930bd5 |
|
BLAKE2b-256 | 07dcf64a43e6381411397c7ca8b26bae564dd43fb49a7d1d60825fd68e8db1bf |