Page tree
Skip to end of metadata
Go to start of metadata

Metamug Console

Metamug Console provides a framework for creating, managing, and hosting REST APIs. REST APIs built with the open-source metamug mason are data-driven, designed easily in few clicks through the user-friendly web console interface.

API security and API permissions are handled by the framework in order to guarantee the security and privacy of data. The platform also provides an automatic generation of API documentation. The framework provides many other features to help developers deliver APIs faster.

Metamug Block Diagram

Metamug Request - Response Flow

Metamug maintains a channel to allow components to communicate with the request and the response. The database access and external API calls are available at every step to allow the components to communicate with the request and database. The request is available to each process in the chain and each process can alter and relay the request information for it's subsequent process.

The response for the request is generated as soon as the request is handled and it is carried forward from process to process until the final process is reached. Here the response is serialized and send back to the client.

Metamug Console is a REST API development platform that makes use of XML to expose secure REST APIs over SQL databases. The objective of Metamug is to minimize the server-side code needed to be written by the developers so that they can focus on building outstanding UI/UX for their REST API driven Apps.

Open-source Mason Runtime

The REST API backends created using Metamug Console make use of Mason, an open-source Java based REST API library.


Single Page WebApps and Mobile Apps do not use entity objects instead they use data formats like JSON/XML. Parsing to entity objects is not required. Marshalling data is done on objects. Metamug converts SQL results straight to JSON/XML as desired.

Request Mapping to SQL

Mapping request parameters to SQL query allows us to define mandatory fields implicitly. The resource file doesn't need to explicitly define the parameter or the NOT NULL property. The non-mandatory parameters sent can be used to use switching between multiple SQL statements. Since roughly 80% of the requests are CRUD operations. Mapping HTTP requests straight to SQL cuts the long route.


Plugins can be developed using Java and Maven for mapping business logic functions to a request. I. Result Processing The default behavior of generating JSON/XML can be overridden to send the custom response using code. II. Request Processing The default behavior of generating JSON/XML can be overridden to send the custom response using code.

Request Pre-processing

The parameters sent to the server can be configured to be validated in the same resource XML before the query is executed.

Live Documentation

As soon as a resource file is updated, its documentation is generated. The generated API document contains parameters to be sent, HTTP methods status codes and validations performed on the server. This helps the app developers consume the API better.

Live API Docs

Hot Deployment

Changes applied to resource XML are propagated immediately to the API. This enables quick fixes to SQL, validations and helps change the request handling as business requirement changes immediately.

API Versioning

Versioning allows the API developer to maintain multiple copies of the same resource with changes. Every version of the resource can handle requests separately.


Database Connection

The REST API backend can be connected to any SQL database and REST APIs can be developed on the database quickly.

External API Requests

HTTP requests to third party APIs can be made using the XRequest feature which allows communication between multiple APIs.

External API Requests

Request Analytics

Metamug Console provides a statistics panel that displays request count and other data related to requests hitting the REST API backend.

API Request Analytics

Backend Export

The REST API backend developed using Metamug console can be exported for use in the production environment. The exported backend is in the form of a Java Web Archive (WAR).

Metamug War Export

Query Catalog and Testing

SQL queries can be saved along with test data values. On saving, the queries are tested on your connected database, allowing you to check their validity. This process ensures the reusability of queries and testing before deployment of the API.

Query Test On Resource Save

The SQL queries written inside a resource file are tested on the connected database before the resource is saved. This ensures that the SQL query does not have any errors before the API is created.

Resource Authentication

Resource XML contains an auth attribute that determines which role can access the resource. The API request made to an authenticated resource can be authorized using Basic-Auth or JWT Auth methods.

RFC Implementation

  • No labels