Use Case: Develop REST API for Database Table(s)

Index Home MAE > MAE Overview > Use Case: Develop REST API for Database Table(s)

MAE has created all the mechanics of receiving, decoding, encoding, and responding to REST API calls as well as a prototype daemon as a code starting point. Further, MAE provides ready access to database tables.

Problem

Your organization is being asked for REST API access to your data, but you don't have REST API development experience on your team.

Or perhaps you have REST API development experience, but the development process is complicated or subject to frequest software revisions which requires more time for your development team than is available.

Either way, you need a solution to allow your development team to create REST APIs quickly, in a straightforward manner, and with minimum software maintainence to your data.

Solution

MAE comes with all the mechanics to handle a REST API call and deliver it to your software as a request.  Create a MAE application to handle the request(s).  Your software handles the request to query/manipulate the data and sends an appropriate response back. Your software doesn't need to worry about web server configuration, data type decoding, data type encoding, or user authentication. Your software focuses on the core functionality of the REST API and data access.

You can access your data directly or use the MAE interface via DbBroker. By using the MAE interface, your application will not need to handle connection to the database, syntax for database queries, or other database implementation-specific details. Those details are configured in DbBroker.

Today, MAE supports the HTTP data operations of GET, POST, PUT, DELETE, and PATCH. Future releases will support more operations.

You can version your API calls.  MAE supports multiple REST API applications; each application is given its own channel, which appears in the URL, such https://maeserver/channel/request. MAE handles decoding and encoding to JSON and XML for your app.

Ask HanoverSoft

Does this solution look like a fit for your organization?  Reach out to HanoverSoft at +1 (919) 270-6712 or info@hanoversoft.net to discuss.

Implementation Guidance

For creating a MAE app to handle a REST API, see Rapid REST API Development.

For querying the database, MAE's interface is the Datastore class.