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.68.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccf59c7fde284bfd4275099e095fb4465c74f52f31665768bda370dca2799c94 |
|
MD5 | b22e67d746c2405e64a2a43da734ec8c |
|
BLAKE2b-256 | c2855722df2af48209f97f142df56cac45a5c6a85e378c5a920fb872be2c7e86 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.68-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 067e4402acc380696815e565fceafafc32dc2a1685ec2a852d625595a4a1e57c |
|
MD5 | 58af22f0098e24ad3d73202cd48b7c61 |
|
BLAKE2b-256 | 6dfe11da57f323ec6580639477d30e4ed70b51ea125f590f3eb650ac62efcfe9 |