{ "info": { "author": "fatiherikli", "author_email": "fatiherikli@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7" ], "description": "Django API Playground\r\n=====================\r\n\r\nA django app that creates api explorer for RESTful APIs.\r\n\r\nWorks with any RESTful API. For example, you can create api explorer for your tastypie based API with this app.\r\n\r\nDemo: `http://api-playground-demo.hipo.biz `_\r\n\r\n.. image:: https://github.com/hipo/Django-API-Playground/raw/master/docs/images/api-playground-2.png\r\n\r\n\r\n\r\nInstructions\r\n\"\"\"\"\"\"\"\"\"\"\"\"\r\n\r\nTo get this application up and running, please follow the steps below:\r\n\r\nInstall from pip::\r\n\r\n pip install django-api-playground\r\n\r\nOr from source::\r\n\r\n pip install git+git://github.com/Hipo/Django-API-Playground.git\r\n\r\nAdd to installed apps::\r\n\r\n INSTALLED_APPS =(\r\n # ...\r\n\r\n 'apiplayground',\r\n )\r\n\r\nInstallation is completed. You can define the API schema now.\r\n\r\nFirs step, Create an url::\r\n\r\n # urls.py\r\n\r\n from api.playgrounds import ExampleAPIPlayground\r\n\r\n urlpatterns = patterns('',\r\n (r'api-explorer/', include(ExampleAPIPlayground().urls)),\r\n )\r\n\r\nSecond step, Define a subclass for your API::\r\n\r\n # api/playgrounds.py\r\n\r\n from apiplayground import APIPlayground\r\n\r\n class ExampleAPIPlayground(APIPlayground):\r\n\r\n schema = {\r\n \"title\": \"API Playground\",\r\n \"base_url\": \"http://localhost/api/\",\r\n \"resources\": [\r\n {\r\n \"name\": \"/feedbacks\",\r\n \"description\": \"This resource allows you to manage feedbacks.\",\r\n \"endpoints\": [\r\n {\r\n \"method\": \"GET\",\r\n \"url\": \"/api/feedbacks/{feedback-id}\",\r\n \"description\": \"Returns a specific feedback item\"\r\n },\r\n {\r\n \"method\": \"POST\",\r\n \"url\": \"/api/feedbacks/\",\r\n \"description\": \"Creates new feedback item\",\r\n \"parameters\": [{\r\n \"name\": \"title\",\r\n \"type\": \"string\"\r\n },\r\n {\r\n \"name\": \"resource\",\r\n \"type\": \"string\"\r\n },\r\n {\r\n \"name\": \"description\",\r\n \"type\": \"string\"\r\n }]\r\n }\r\n ]\r\n },\r\n ]\r\n }\r\n\r\nThat's all. More detailed documentation will be coming soon.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Hipo/Django-API-Playground", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "django-api-playground", "package_url": "https://pypi.org/project/django-api-playground/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-api-playground/", "project_urls": { "Homepage": "https://github.com/Hipo/Django-API-Playground" }, "release_url": "https://pypi.org/project/django-api-playground/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "API Playground for RESTful APIs", "version": "0.1.0" }, "last_serial": 789094, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "8096ed2c2fe78996e88ecc50413e5fa1", "sha256": "b874e4825f178f002b518bdc91244bd5dcc4cae8d1b58d9a113174409cdb1ef9" }, "downloads": -1, "filename": "django-api-playground-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8096ed2c2fe78996e88ecc50413e5fa1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45257, "upload_time": "2012-10-05T13:25:12", "url": "https://files.pythonhosted.org/packages/72/b6/73dcc71c2b21328879c8f233dd7845d32da76ed90692be198297cd9bfc4b/django-api-playground-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8096ed2c2fe78996e88ecc50413e5fa1", "sha256": "b874e4825f178f002b518bdc91244bd5dcc4cae8d1b58d9a113174409cdb1ef9" }, "downloads": -1, "filename": "django-api-playground-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8096ed2c2fe78996e88ecc50413e5fa1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45257, "upload_time": "2012-10-05T13:25:12", "url": "https://files.pythonhosted.org/packages/72/b6/73dcc71c2b21328879c8f233dd7845d32da76ed90692be198297cd9bfc4b/django-api-playground-0.1.0.tar.gz" } ] }