diff options
| author | Tom Christie | 2012-08-29 20:57:37 +0100 |
|---|---|---|
| committer | Tom Christie | 2012-08-29 20:57:37 +0100 |
| commit | 578017e01d1da4746ae0045268043cfd74d41b42 (patch) | |
| tree | d729eb93484247fa44b509a4b693811e6978a190 /docs/howto/usingcurl.rst | |
| parent | 21f59162db37c656b4f025cdd8e13cdb9933a4fc (diff) | |
| download | django-rest-framework-578017e01d1da4746ae0045268043cfd74d41b42.tar.bz2 | |
New docs
Diffstat (limited to 'docs/howto/usingcurl.rst')
| -rw-r--r-- | docs/howto/usingcurl.rst | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/docs/howto/usingcurl.rst b/docs/howto/usingcurl.rst deleted file mode 100644 index eeb8da06..00000000 --- a/docs/howto/usingcurl.rst +++ /dev/null @@ -1,30 +0,0 @@ -Using CURL with django-rest-framework -===================================== - -`curl <http://curl.haxx.se/>`_ is a great command line tool for making requests to URLs. - -There are a few things that can be helpful to remember when using CURL with django-rest-framework APIs. - -#. Curl sends an ``Accept: */*`` header by default:: - - curl -X GET http://example.com/my-api/ - -#. Setting the ``Accept:`` header on a curl request can be useful:: - - curl -X GET -H 'Accept: application/json' http://example.com/my-api/ - -#. The text/plain representation is useful for browsing the API:: - - curl -X GET -H 'Accept: text/plain' http://example.com/my-api/ - -#. ``POST`` and ``PUT`` requests can contain form data (ie ``Content-Type: application/x-www-form-urlencoded``):: - - curl -X PUT --data 'foo=bar' http://example.com/my-api/some-resource/ - -#. Or any other content type:: - - curl -X PUT -H 'Content-Type: application/json' --data-binary '{"foo":"bar"}' http://example.com/my-api/some-resource/ - -#. You can use basic authentication to send the username and password:: - - curl -X GET -H 'Accept: application/json' -u <user>:<password> http://example.com/my-api/ |
