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.526.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0090d4c5c55d1f630529e5380e25168d4950d7327615d3976367909b99939cf |
|
MD5 | 5f727e35b70f55b9f17f36985cd85a13 |
|
BLAKE2b-256 | ca450270ca6354d9ff428888431d5ccc6b6ced18903fce26e39b499f0c5a782f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.526-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb1c6d6c1b96701bc9443ca5de7b60ddc52f612d5a8bddcc4406a8b975bb0068 |
|
MD5 | 3f1bb513f24b3c503af245ead2f58a1f |
|
BLAKE2b-256 | 2a380bb7c8df778d849fdf53c12056aa6f06618f9818b76a4435f25a2bb61bc1 |