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.531.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04b7c244c4aa0285eccc8ab842a8d6e2593c7b0983ff5ad757d5c603cb8574df |
|
MD5 | 5f14d37b056807fb84e52cdc0b5f6454 |
|
BLAKE2b-256 | 0eae0203a80be303cabcc1b696c473b436e8d2e92d54df4dea5171e783ccc11c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.531-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b462d537dd99d3adcb2439edb9eacae84019569720a12a9054c3a5d659b6203b |
|
MD5 | 1010ae4fc927949e553298c93b991139 |
|
BLAKE2b-256 | 5c94501c85d4791ed45418f93a9623d711bdecf4063e7f054b836badf3580cb2 |