REST interfaces are popular in CRUD applications as it provides a clean and well defined interface between the client and server. Editor can be fully integrated
with a REST environment through its ability to specify different URLs for the create, edit and remove actions of Editor. This is done by giving ajax as an object with the
create, edit and remove properties specified with the URL to use for each action, as shown in this example.
In addition to being able to specify a unique URL for each action, you can also specify full jQuery Ajax options for each action by giving the Ajax properties
as an object. In this example the type option is used to specify the HTTP method to be used for each action, as REST interfaces typically require.
Note also that the server returns a 400 Bad request response to invalid data, which is correctly handled by Editor.
Editor's ajax.replacements object can also be useful when working with a REST API - it allows a list of keys to be replaced in the
URL based on the data being submitted. Each key is assigned a function that you would return the replacement value for. By default, as shown in this example,
Editor will replace {id} with the id of the row(s) being edited or deleted.
The Javascript shown below is used to initialise the table shown in this example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | var editor; // use a global for the submit and return data rendering in the examples$(document).ready(function() { editor = new $.fn.dataTable.Editor( { ajax: { create: { type: 'POST', url: '../../controllers/rest/create.php' }, edit: { type: 'PUT', url: '../php/rest/edit.php' }, remove: { type: 'DELETE', url: '../../controllers/rest/remove.php' } }, table: "#example", fields: [ { label: "First name:", name: "first_name" }, { label: "Last name:", name: "last_name" }, { label: "Position:", name: "position" }, { label: "Office:", name: "office" }, { label: "Extension:", name: "extn" }, { label: "Start date:", name: "start_date", type: "datetime" }, { label: "Salary:", name: "salary" } ] } ); $('#example').DataTable( { dom: "Bfrtip", ajax: "../../controllers/rest/get.php", columns: [ { data: null, render: function ( data, type, row ) { // Combine the first and last names into a single table field return data.first_name+' '+data.last_name; } }, { data: "position" }, { data: "office" }, { data: "extn" }, { data: "start_date" }, { data: "salary", render: $.fn.dataTable.render.number( ',', '.', 0, '$' ) } ], select: true, buttons: [ { extend: "create", editor: editor }, { extend: "edit", editor: editor }, { extend: "remove", editor: editor } ] } );} ); |
In addition to the above code, the following Javascript library files are loaded for use in this example:
Editor submits and retrieves information by Ajax requests. The two blocks below show the data that Editor submits and receives, to and from the server. This is updated live as you interact with Editor so you can see what is submitted.
The following shows the data that has been submitted to the server when a request is made to add, edit or delete data from the table.
// No data yet submittedThe following shows the data that has been returned by the server in response to the data submitted on the left and is then acted upon.
// No data yet received