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.71.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c69b18a9dae16b85a3e9ab727aaea8d6074c93a44b4f10e1ec6b31ec613d8db5 |
|
MD5 | 72697790e400e5344de6d4de1086853a |
|
BLAKE2b-256 | 8fd2087578da82418f5ea9b9210abd3f7e78e028ce9cbc41d8b00d8aefa58309 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.71-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6f00bf68dee9f4ad73c80c26f916a84b17ac9e44c4a86b76238991ac4109823 |
|
MD5 | 2bbc6f92b9632b68fe52c8de3c5b0f50 |
|
BLAKE2b-256 | f6eab29cb39e30e4dc1a105b75a71c2d6b3fad55c8b8bdcbb74d66f0aba0c1ff |