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.743.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48e7ec83bcdc5d2a7697684c79ec97f6f1a7478b21dacc177efb4b7a2c821c3e |
|
MD5 | ec6a8440cd2a9d4061f6a555a67e7010 |
|
BLAKE2b-256 | 51ddec40f529167134bfb8db836829b4e81bf0847cfaeed9eb19b82d005da552 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.743-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d5fc2d8e16726c733520173da72ae7188e9aa6cdab62819b225b3f69bcc4233 |
|
MD5 | 8947478bc083c4229d17f66a8dd67d8d |
|
BLAKE2b-256 | f7a6e9197bedc97ba9b081e9978aa39786658374391f8c59a18c92f5e4f3368c |