https://github.com/davidgilbertson/realsimplerest

A real simple REST server
https://github.com/davidgilbertson/realsimplerest

Last synced: 13 days ago
JSON representation

A real simple REST server

• Host: GitHub
• URL: https://github.com/davidgilbertson/realsimplerest
• Owner: davidgilbertson
• Created: 2013-10-11T21:11:42.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-13T02:30:58.000Z (about 11 years ago)
• Last Synced: 2023-08-04T17:21:43.538Z (over 1 year ago)
• Language: PHP
• Size: 133 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Real Simple REST

A trio of files to make talking to a server easier.

For the less seasoned coders, think of it as a way to map a function in JavaScript to a function in PHP without having to worry about all the middle stuff.

This is for use with Apache/PHP servers. It'll work just fine out of the box, and the code is minimal so it's easy to mash it up and work into your own project.

To get started, put rest.js, rest.php, .htaccess and testPage.html all in the same directory and open testPage.html in your browser.

If you're the inpatient type, you can see it in action at http://kronia.com.au/dev/rest/testPage.html

## Front End

rest.js allows you to pass a model and a CRUD operation to a function and have the rest done automagically.

Accepts an object with the following properties

`method` 'create' | 'read' | 'update' | 'delete'

`id` must be supplied when the method is 'read', it's the ID of the thing you want to read

`modelType` must be supplied when the method isn't read. This is the type thing you're dealing with (e.g. a 'task')

`model` the model, as a JavaScript object

`callback` a callback function called when the request completes successfully

#### Example

```javascript

myApp.sync({

	method: 'create',

	modelType: 'task',

	model: model,

	callback: function(response) {

		//do something with the response

	}

});

```

Note that the file uses JSON, so if you're targeting older (