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.86.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f8a464e524af611f92c9a8511a7c922369a1b3bddd779a4c5e5136c2592494b |
|
MD5 | e6d88123c7284cb9d549ed78420bb2d8 |
|
BLAKE2b-256 | a3848e7a8d20e17e22277bd774051799d4e52d3f8adc2ba93fb5ae860972cd73 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.86-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cde96045977a2ddb9d93b10f5143b49b2c3dacfc872ab5a86d5a8005e45e20c |
|
MD5 | e36715513cd5e27508714c3344c98039 |
|
BLAKE2b-256 | 864c5d0fa0ac629354cad200bc2ce183de4528ef503f0979953f31328822897b |