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.717.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb2fdbc4127738c80c060cfee19ec9c06b0913dc191b8f94274307d163c41435 |
|
MD5 | c9e7c414e10ea10ef49fb1261c43bf48 |
|
BLAKE2b-256 | 67dbad0bb3566a10cf32cc042346c572c1989c55330a0527c8602d5fd3b51e03 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.717-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f9b1560539f4a06fda9110e0c85e7a1713cc591504c84ca484144751d983170 |
|
MD5 | 621839348bcc10ee9f1976f7639be29b |
|
BLAKE2b-256 | 90d0cfa60c70ea8a07326634e30d869c0d5fc76c59dd4bac0437d501adeab32a |