Difference between revisions of "Sudo API"

632 bytes added ,  15:52, 13 December 2012
no edit summary
(creates page)
 
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
The Sudo API is a project to serve and receive programmatic data for and about sudo room. This layer should act as an intermediary with every other relevant Sudo Room application. It speaks REST and will have a full specification outlined below:
The Sudo API is a project to serve and receive programmatic data for and about sudo room. This layer should act as an intermediary with every other relevant Sudo Room application. It speaks REST (in many formats, read more about the [http://django-rest-framework.org/topics/browsable-api.html browsable API]), is written in [https://en.wikipedia.org/wiki/Python_%28programming_language%29 python] with [https://www.djangoproject.com/ Django], and has a full API schema specification below.


==Specification==
==Software Stack==
===Based on:===
* Gitorious repo: [https://gitorious.org/+sudo-room/sudo-api/sudo-api https://gitorious.org/+sudo-room/sudo-api/sudo-api]
* [http://hackerspaces.org/wiki/Status_API the HackerSpace Status API]
* Software overview:
** Python
** Django
** Django Rest Framework
* Based on:
** [http://django-rest-framework.org/topics/browsable-api.html Django Rest Framework Tutorial]
** [http://hackerspaces.org/wiki/Status_API the HackerSpace Status API]
* Tested with:
** [http://openspace.slopjong.de/ Validator].
 
==API Specification==
===0.1===
===0.1===
====Status object====
====Status object====
Line 44: Line 54:
** type (string, optional) - mime-type of the feed (implementors should not rely on auto-detection of their feed type and are advised to provide this optional field)
** type (string, optional) - mime-type of the feed (implementors should not rely on auto-detection of their feed type and are advised to provide this optional field)
** url (string, mandatory) - url to the feed content
** url (string, mandatory) - url to the feed content
[[Category:Projects]]