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.580.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38e8af0a002bc4175b1769bc69024efb1d3a9abeb86980756c49439d0b8274f6 |
|
MD5 | 56ec5cd68800a7963e922bafaefd7926 |
|
BLAKE2b-256 | d8faedd4734acaf607b056c509a8e400442f34ea3769136e52bb4b8eddaaf315 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.580-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69e7a339127d831be8abde291ce8f8af732f5c3e7c8f41f08c4b362d7213f0c8 |
|
MD5 | ea46424b087f5fad56c5bb6390ec0d19 |
|
BLAKE2b-256 | f058b825aae08f9747d89e9e805e1f8988615bc30db3b6e84b7a30be26801261 |