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.211.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9eb124b86b2b2ff42b496dcf1982e423a7b28dc8c66faa85f85f06edb575c2af |
|
MD5 | 65b8cdbaaff2b75e5b674e2cd0e82092 |
|
BLAKE2b-256 | 142b741d3b95a903b47d139d55fbaedbb257252c07dff980293642b8545f827c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.211-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c46003bfa2a028ab8a1d1a6775a68a7ca0ed2862bdaf57a215a6cc10f85dd6b2 |
|
MD5 | 2846a39634b8ccc6139da00fe8744de0 |
|
BLAKE2b-256 | d1f5ed05d95e3a05da537147a1d2215110ff574fcda4bce251e30f772d6ef6d3 |