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.693.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85ff5a5425b41fc8144943b5e3cc8a5c64671a7b8d9d5ad343748b5e31ae1e9c |
|
MD5 | 4fd36fe618f28f154141a2ff1032f723 |
|
BLAKE2b-256 | 8092bd919fe6958aee8c12b1cdde33a934dbc1f398ac580dd94e3ae063da414a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.693-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1322f5042623e8fa4a16f8c8e3bf26056a54e7d825bf72b2dbb0a49e977e2d3 |
|
MD5 | 6d7aad16307e4cb4184e27ab86ebad5c |
|
BLAKE2b-256 | 06db5e79b4682806b29925e7e630d2460a632bebaaca79639884d65b49f0d412 |