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.395.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82894d7c3af332bf91b9e174792a0c804c803a75a8eef5ab64935c8fa717be60 |
|
MD5 | c46bb55b8ee3cdfb3b2a677d3de468e0 |
|
BLAKE2b-256 | 5a2128ff13587f8bbc1ea3cc3fb0869509e3931d9b8d403902fa33ad7f21d544 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.395-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60e28d11bfb6d4d22a2dff8e28a257c5b1d86c3b21ab5d6074c1849e8a9268e8 |
|
MD5 | 79b5ddb0235b0f5c3cc01ba04b5c0d48 |
|
BLAKE2b-256 | f2a1c60843b0956e49737c1492cf6a6671f6de617ca1d656d7eae926fe5e3888 |