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.751.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b0fe8883790d3336a211f7a9ecd9dd7c41cb1801c2c1496a13246f6b4ef38f7 |
|
MD5 | 01aa0d98f58503ae91f39af24c92fc2f |
|
BLAKE2b-256 | 165ffdf28d81e460b04b25fe7440b6be00f119f2be50fc4af1305ce76a923d16 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.751-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bd7e63faf498df880d0ce4e8d8341299e1a2e79823f81a2df5e94b8a63dd13c |
|
MD5 | 319456b01e841968021f7d9b32d958f3 |
|
BLAKE2b-256 | 0771d2b25909f518f6009e95575c971a234ef8ccda98d2f3711d3869126c919b |