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.655.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1dfd4a0c9a4716c0134b3b08cbae41c565d61e901aa87a25411aa38219fcbf5a |
|
MD5 | d2e9601c3c48a8c0b7488eb0c004bc00 |
|
BLAKE2b-256 | 81f7cde48df94736267feefda2fed91368105f7dacecad16c25a598e2a4009c2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.655-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11b727b14a738cce045b8b6bce9e09f4abe3029dfabed353abae07dc5771451e |
|
MD5 | 4feda2cb9c373addb9fcd11d47b2cd2e |
|
BLAKE2b-256 | 68c83228fb10c303e9af307f68d152cb049449064b2b36925f555c9d83f7c17c |