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.542.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13d63d9910c895d563c3877addd1a1a24b79536fa142ad358c34b96fde306a57 |
|
MD5 | 434b4ad88c2200be9ea9975710f7f311 |
|
BLAKE2b-256 | 26fca77911cd700e32e8ffba8491734e91afbb9f261ccfa0804f769109818313 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.542-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da6232b8e6fc591ec8a70b0b21f7f18ba6a473d36585cecc9ee002b8ffea5ca0 |
|
MD5 | 7c528d91f7aebd271e52b18bcb95a492 |
|
BLAKE2b-256 | 351142918716ba83ed1eaad1b34ac5f971abc09151f564b9a56f71dfd1f00ec1 |