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.262.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41bf3c38755a17db4a073c0e180d2ed0202f2c6b69eb76d12b088df3900d6482 |
|
MD5 | f9c8b794e492c33cbc2a730ec03786ac |
|
BLAKE2b-256 | bb9153c8c3456ad6e0c6ddb01d1ba3a0fd63a35d7c07a7cbc29708b6438cf80e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.262-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f0804110802f7a885cd9ca6442007fb31a3437cf4e6ed991c2a6aa7d7cb8acf |
|
MD5 | 5db94bc9ae4d73308aa57f648692f319 |
|
BLAKE2b-256 | 6f99269996095d7ad9efb162c27ce069a6b33e47a34ddc2b392c583d67e0c528 |