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.772.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b6473cc0fb5f47ce485a0972d32c136c367d10d477920b63053f7b726d27e69 |
|
MD5 | fb716145123d992f56d7431b910311ea |
|
BLAKE2b-256 | 932e83ff65fdd73f1d65102e3fb7fab553c35f8ec153588b57513254093989c0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.772-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b95704f6fe9f25118dd1268648d930c7b50cb0c46d0acfca6cba3835647592e5 |
|
MD5 | 172c07bac5ad17e3234298202a6ca1b1 |
|
BLAKE2b-256 | 748e3f783746b3e2ed0c0d0b29a3338d2de898a561c8a0e7e46641dbd8ee56e5 |