rest

mORMot REST Client-Server Units

Folder Content

This folder hosts the RESTful oriented features of the mORMot Open Source framework, version 2.

REST In mORMot

REST stands for REpresentation State Tranfer, and is a way of communicating between clients and servers. Our framework uses JSON for the REpresentation of data between two ends. In practice, you will use HTTP/HTTPS or WebSockets as communication layer of the REST process. But our parent TSQLRest class is abstract for any actual mean of communication, and could actually involve a direct in-process call.

The framework has a REST orientation, but is not trully RESTful. You could let mORMot publish the ORM layer over REST, but it is better not to be used on production, for obvious security and design reasons. So the framework will offer a REST set of services, which will be defined as methods-based-services or interface-based-services - the later being the most efficient and clean way of defining endpoints. Depending on how those services are defined, they be more RPC (Remote-Processing-Call) oriented than REST (resource) oriented.

JSON has been found out to be a simple but very powerful mean of data representation, and our framework tries to leverage its usage from the ground up. For instance, the ORM layer (from mormot.orm.core.pas) is able to create efficient JSON from the lowest level of the supported Database engines, and the client side can consume this JSON with very few resource consumption, on all possible platforms - including JavaScript.

Composition Over Inheritance

One goal of the mORMot 2 rewrite was to follow the SOLID principle.

Our REST approach publishes a TRest class, and its Client and Server inherited classes, which offers:

• Object-Relational-Mapping via its ORM: IRestORM interface field;
• Service-Oriented-Architecture via its Services field;
• Threading abilities in its Run field;
• REST-specific features are isolated also in this TRest class, like URI routing and execution, authorization and authentication, and sessions support.

Units Presentation

mormot.rest.core

Shared Types and Definitions for Abstract REST Process

• Customize REST Execution
• TRestBackgroundTimer for Multi-Thread Process
• TRestRunThreads Multi-Threading Process of a REST instance
• TRest Abstract Parent Class
• RESTful Authentication Support
• TRestURIParams REST URI Definitions
• TRestThread Background Process of a REST instance
• TOrmHistory/TOrmTableDeleted Modifications Tracked Persistence

mormot.rest.client

Client-Side REST Process

• Client Authentication and Authorization Logic
• TRestClientRoutingREST/TRestClientRoutingJSON_RPC Routing Schemes
• TRestClientURI Base Class for Actual Clients
• TRestClientLibraryRequest after TRestServer.ExportServerGlobalLibraryRequest

mormot.rest.server

Server-Side REST Process

• TRestServerURIContext Access to the Server-Side Execution
• TRestServerRoutingREST/TRestServerRoutingJSON_RPC Requests Parsing Scheme
• TAuthSession for In-Memory User Sessions
• TRestServerAuthentication Implementing Authentication Schemes
• TRestServerMonitor for High-Level Statistics of a REST Server
• TRestRouter for efficient Radix Tree based URI Multiplexing
• TInterfacedCallback/TBlockingCallback Classes
• TRestServer Abstract REST Server
• TRestHttpServerDefinition Settings for a HTTP Server

mormot.rest.memserver

Standalone REST In-Memory Server Using JSON or Binary Persistence

• TRestOrmServerFullMemory Standalone REST ORM Engine
• TRestServerFullMemory Standalone REST Server

mormot.rest.sqlite3

REST Server and Client Using an Embedded SQLite3 Database Engine

• TRestServerDB REST Server with Direct Access to a SQLite3 Database
• TRestClientDB REST Client with Direct Access to a SQLite3 Database

mormot.rest.http.client

Client-Side REST Process over HTTP/WebSockets

• TRestHttpClientGeneric and TRestHttpClientRequest Parent Classes
• TRestHttpClientWinSock REST Client Class over Sockets
• TRestHttpClientWebsockets REST Client Class over WebSockets
• TRestHttpClientWinINet TRestHttpClientWinHTTP Windows REST Client Classes
• TRestHttpClientCurl REST Client Class over LibCurl

mormot.rest.http.server

Server-Side REST Process over HTTP/WebSockets

• TRestHttpServer RESTful Server
• TRestHttpRemoteLogServer to Receive Remote Log Stream

mormot.rest.mvc

Model-View-Controller (MVC) pattern and Mustache over TRestServer and TOrm

• MVC/MVVM Application over a TRestServer
• Expression Helpers for the ORM Data Model