Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
django-rest-framework
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
django-rest-framework
Commits
e82ab8ea
Commit
e82ab8ea
authored
Dec 30, 2011
by
Marko Tibold
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added a simple example of how to use urllib and urllib2 to interact
with an api.
parent
2394fc70
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
44 additions
and
11 deletions
+44
-11
docs/contents.rst
+2
-1
docs/howto.rst
+8
-0
docs/howto/usingurllib2.rst
+33
-0
docs/index.rst
+1
-10
No files found.
docs/contents.rst
View file @
e82ab8ea
...
@@ -3,7 +3,8 @@ Documentation
...
@@ -3,7 +3,8 @@ Documentation
.. toctree::
.. toctree::
:maxdepth: 2
:maxdepth: 2
howto
library
library
examples
examples
docs/howto.rst
0 → 100644
View file @
e82ab8ea
How Tos, FAQs & Notes
=====================
.. toctree::
:maxdepth: 1
:glob:
howto/*
docs/howto/usingurllib2.rst
0 → 100644
View file @
e82ab8ea
Using urllib2
=============
Python's standard library comes with some nice modules
you can use to test your api or even write a full client.
Here's an example which does a 'GET' on the `model-resource` examle
in the sandbox.::
import urllib2
>>> r = urllib2.urlopen('htpp://rest.ep.io/model-resource-example')
# You can check if the response was ok:
>>> r.getcode()
200
# Or examin the resonse itself:
>>> print r.read()
[{"url": "http://rest.ep.io/model-resource-example/1/", "baz": "sdf", "foo": true, "bar": 123}]
And here's an example which does a 'POST' to create a new instance::
# First encode tha data we want to POST, we'll use urllib for encoding
# and the time module to send the current time as as a string value for our POST
>>> import urllib, time
>>> d = urllib.urlencode((('bar', 123), ('baz', time.asctime())))
# Now use the Request class and specify the 'Content-type'
>>> req = urllib2.Request('http://rest.ep.io/model-resource-example/', data=d, headers={'Content-Type':'application/x-www-form-urlencoded'})
>>> resp = urllib2.urlopen(req)
>>> resp.getcode()
201
>>> resp.read()
'{"url": "http://rest.ep.io/model-resource-example/4/", "baz": "Fri Dec 30 18:22:52 2011", "foo": false, "bar": 123}'
That should get you started to write a client for your own api.
docs/index.rst
View file @
e82ab8ea
...
@@ -92,16 +92,7 @@ The following example exposes your `MyModel` model through an api. It will provi
...
@@ -92,16 +92,7 @@ The following example exposes your `MyModel` model through an api. It will provi
url(r'
^(?
P
<
pk
>[^/]+)/$
', InstanceModelView.as_view(resource=MyResource)),
url(r'
^(?
P
<
pk
>[^/]+)/$
', InstanceModelView.as_view(resource=MyResource)),
)
)
How Tos, FAQs & Notes
.. include:: howto.rst
---------------------
.. toctree::
:maxdepth: 1
howto/setup
howto/usingcurl
howto/alternativeframeworks
howto/mixin
.. include:: library.rst
.. include:: library.rst
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment