Skip to content

ako/ApiConnector

Repository files navigation

Mendix Api connector

Example project to illustrate how you can use the Mendix Connector Kit to create APIs for your Mendix application using microflows.

Usage

This project implements a connector to create an API for a mendix project implemented using microflows. The following Java actions are implemented to enable this:

  • Register API endpoint
  • Register API endpoint with mapping
  • API Header Location
  • API Status 201 - Created
  • API Status 404 - Not found

API connector toolbox actions

Register a new API

A microflow API

The following action illustrates how to register a new API:

Register API

The following microflow implements the get product by EAN API:

Get product by EAN

Another example, a microflow to implement create new product API:

Create product

Register an OQL API

The following action illustrates how to register an OQL endpoint:

Register OQL API

Register a binary API implemented using a Microflow

The following registered an endpoint to return images:

Register Binary Microflow API

The implementation returns a subclass of a FileDocument entity:

Microflow API implementation for a binary endpoint

The microflow also illustrates how you can set the content type of the response and how you can control caching.

Register a pdf report API

The following registers an API endpoint returning a pdf report:

Register PDF Endpoint

Implementation of the endpoint generating a pdf report:

Generate PDF report Microflow

Build

To run this project from the Mendix modeler you need to download the required java dependensies. You can do this by running runivy.cmd

About

Connector kit example project: expose microflows as APIs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages