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.553.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 522c785285bbd7bda48813345f205f9ab259cb67a7f6f1cfe32408015557d0d0 |
|
MD5 | 1e68b8ff39ac502744be852c1431106f |
|
BLAKE2b-256 | f03d2d65aca40e5ca11d95a297c7eeb5331a1c629d1b0959268def27f8182eb3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.553-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a979892a09bac4b1510db05b77f64c571641d59e970170b385455048c8af584 |
|
MD5 | 04f0e454791d158fae65aac8fdd3a4ac |
|
BLAKE2b-256 | f9a72f473e6acf16aae3a14af50dd769fc59a4d851af1d337f9e8290ca9d14f6 |