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.800.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47620d8cc5d62aec152094d4b153987064d482b961304af2297d831d4e2ee6e2 |
|
MD5 | 441f9cb054ce4614910a33f40a719b2f |
|
BLAKE2b-256 | 2b79ba42d002574c731a81928a2f3f248e5b9740021d0c65da532a5be0531a89 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.800-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a620b80bb81de5f8f72cca6d21a2c5521899f266da21c08b37623c52ed2dc4c7 |
|
MD5 | 7b6c31068eb665fcfa1063891bbf4668 |
|
BLAKE2b-256 | 8b45edc44de4abe7d58ff3b14b54e9f2b922fc0c29bb4b75d4e00575103fcb0d |