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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb947baeef4bef8256ac0240cb8f25d6775f6bada7901fc3033b421011970f9d |
|
MD5 | 927b216a72a2c335f4d97a33441de540 |
|
BLAKE2b-256 | bd948c3b5a98d7c66accb6665273b3eee7e9c7281bd54d2f309706e4606eb8c6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1f1ee2df9554768a235dfffef8c200e4e48dc3dd3ba473cf875dde96ec8567c |
|
MD5 | 79b3ea59edbcb5d6aaa9c58b083e73a6 |
|
BLAKE2b-256 | 709acfe61c0e7f71fa8f7e40838d72790e3139b8fdf3ea3d2ee0d63252674a2d |