API Playground for RESTful APIs
Project description
A django app that creates api explorer for RESTful APIs.
Works with any RESTful API. For example, you can create api explorer for your tastypie based API with this app.
Demo: http://api-playground-demo.hipo.biz
Instructions
To get this application up and running, please follow the steps below:
Install from pip:
pip install django-api-playground
Or from source:
pip install git+git://github.com/Hipo/Django-API-Playground.git
Add to installed apps:
INSTALLED_APPS =( # ... 'apiplayground', )
Installation is completed. You can define the API schema now.
Firs step, Create an url:
# urls.py from api.playgrounds import ExampleAPIPlayground urlpatterns = patterns('', (r'api-explorer/', include(ExampleAPIPlayground().urls)), )
Second step, Define a subclass for your API:
# api/playgrounds.py from apiplayground import APIPlayground class ExampleAPIPlayground(APIPlayground): schema = { "title": "API Playground", "base_url": "http://localhost/api/", "resources": [ { "name": "/feedbacks", "description": "This resource allows you to manage feedbacks.", "endpoints": [ { "method": "GET", "url": "/api/feedbacks/{feedback-id}", "description": "Returns a specific feedback item" }, { "method": "POST", "url": "/api/feedbacks/", "description": "Creates new feedback item", "parameters": [{ "name": "title", "type": "string" }, { "name": "resource", "type": "string" }, { "name": "description", "type": "string" }] } ] }, ] }
That’s all. More detailed documentation will be coming soon.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for django-api-playground-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b874e4825f178f002b518bdc91244bd5dcc4cae8d1b58d9a113174409cdb1ef9 |
|
MD5 | 8096ed2c2fe78996e88ecc50413e5fa1 |
|
BLAKE2b-256 | 72b673dcc71c2b21328879c8f233dd7845d32da76ed90692be198297cd9bfc4b |