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.620.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2d8ff689affbb44512b9c2b89d060477986e06b2b4ad8e02fba269d3a81200e |
|
MD5 | 6dc17abe1f928b4ac34dac1bd513e73f |
|
BLAKE2b-256 | a9e114000a77434750cbdf7a218b06b3a09c5b8e159c2937051f04f813f8c835 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.620-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff2733db1c17e6b558636c0636b72e10eb15def0ffe990bd7500cb61fb9ff740 |
|
MD5 | 074fb62efa98105074e9224102f730ab |
|
BLAKE2b-256 | e1c9f964849926ac4797c76a02ceed6845701b6c5b04797117d8130599f4911e |