Kule is a REST interface for MongoDB. You can use kule as a temporary backend for your backend needed apps.
- Bottle
- Pymongo
python -m kule --database foo --collections users,documentsThat's all.
Now you can interact with your API.
| Method | Path | Action |
|---|---|---|
| GET | /users | Returns all records. You can give limit and offset parameters to paginate records. |
| GET | /users/:id | Returns a single document |
| POST | /users | Creates a new document |
| PUT | /users/:id | Replaces an existing document |
| PATCH | /users/:id | Updates a document |
| DELETE | /users/:id | Removes an existing document |
You can customize your API response for your requirements. For example, you can provide authentication method.
You can override an existing endpoint.
from kule import Kule
class MyKule(Kule):
def delete_detail(self, collection, pk):
return self.not_implemented()You can override specific endpoint with kule's magical methods.
from kule import Kule
class MyKule(Kule):
def get_users_list(self, collection):
return ["merhaba", "hello", "hola"]Also there is a way to build customized bundles.
from kule import Kule
class MyKule(Kule):
def build_users_bundle(self, user):
first_name, last_name = user.get("full_name").split()
return {
"first_name": first_name,
"last_name": last_name
}mykule = MyKule(database="foo")
mykule.run()You have to override the parse method of collections. Because models listing
on objects key.
Backbone.Collection.prototype.parse = function(data) {
return data.objects ? data.objects : data;
};
// examples
var Document = Backbone.Model.extend({
urlRoot: "/documents",
idAttribute: "_id"
});
var Documents = Backbone.Collection.extend({
model: Document,
url: "/documents"
});
// lets play
var _document = new Document({"title": "hello"});
_document.save()