Developer Guide
Set up the MariaDB REST Service, define REST services and endpoints, serve static content and MRS scripts, secure the endpoints, and deploy REST services from development to production.
The developer guide of the MariaDB REST Service (MRS) covers the tasks of building REST services, from configuring a MariaDB server for MRS to deploying a finished REST service on a production server.
You define REST services with REST SQL statements, which MariaDB Shell runs in SQL mode, or with the dialogs of MariaDB Shell for VS Code. The statements are documented in the REST SQL Reference. How the MariaDB REST Daemon serves the REST services is described in Architecture.
A typical project goes through these steps:
- Configure MRS on a MariaDB server and grant the MRS roles to the developers.
- Add a REST service and expose database schemas, tables, views, and routines as REST endpoints.
- Design the JSON documents the endpoints return with REST data mapping views.
- Serve the files of a web app and run server-side TypeScript with static content and MRS scripts.
- Protect the endpoints with authentication and authorization.
- Test the endpoints interactively in a DB Notebook.
- Deploy the REST service to a test or production server.