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.270.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 344274f984ad23e4fd68caeaa32caec9d02e79a7afd366196d1a383079c0f24d |
|
MD5 | 2ab3dcbc38dd97b66c01a849926924b8 |
|
BLAKE2b-256 | 866f94e3e52546755f838bddbf28babda35dda30e6b06b27b40191fed5ad4283 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.270-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4ecd65d13faa11f2ecc97a904148ef8062a584322289bd7893b2a6422b32ec4 |
|
MD5 | fadfb1dcffcc83b33ec9164583219b8c |
|
BLAKE2b-256 | 091957a187cb9adbce1aabf9e8876657024ffae770d47e3527ec92821f900d93 |