Technical Details of Published REST

Last modified: February 23, 2024

1 Introduction

This section of the Published REST documentation describes more technical aspects of the published REST capabilities of Mendix.

You can use published REST without knowing any of the details here. These documents allow you to further customize and troubleshoot Mendix published REST services.

2 Technical Documentation for Mendix Published REST

2.1 Published REST Routing

This page shows how an incoming HTTP request is processed and which operation will be executed for a given request.

It can be used both for troubleshooting and to aid in designing your published REST service.

2.2 JSON Schema

Technical details of the JSON Schema, which is created to support import and export mappings for an OpenAPI (Swagger) documentation page.

2.3 OpenAPI 3.0 Documentation

Technical details of the openapi.json file, which is created to describe the published REST service on an OpenAPI documentation page.

2.4 OpenAPI 2.0 Documentation

Technical details of the swagger.json file, which is created to describe the published REST service on an OpenAPI (Swagger) documentation page.

2.5 Parameters for the Custom Authentication Microflow

Describes the parameters which are passed to a microflow, which is performing custom authentication for a published REST service.