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.786.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | baa184fe4b0a1e3ce890cd475a056282e2dc571800f91d12bd13f36c4630ad0c |
|
MD5 | 2987b7b60605e140d5bfa21d7699b1a8 |
|
BLAKE2b-256 | 5486f9e9ca8deaf207a9417a188e60a10f18e2d1789688a3a3f96c182d8a0416 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.786-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7c28b8bdbaf3ec30fbb3902ad9ab19633d78bfbe6e9f87ed7f6e9876fd79cb2 |
|
MD5 | f242bbbecc5980e89515c93ed4b135ef |
|
BLAKE2b-256 | a7b873adfcc064962c73227e58f0f0b2188b84689af6da3ed727edc120e9cf7c |