{"id":973,"date":"2016-03-28T20:06:00","date_gmt":"2016-03-28T20:06:00","guid":{"rendered":"https:\/\/fir3netwp.gmsrrpobkbd.com\/2016\/03\/28\/how-to-build-a-restful-api-using-the-django-rest-framework\/"},"modified":"2021-07-31T15:12:19","modified_gmt":"2021-07-31T15:12:19","slug":"how-to-build-a-restful-api-using-the-django-rest-framework","status":"publish","type":"post","link":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html","title":{"rendered":"How to Build a RESTful API using the Django REST Framework"},"content":{"rendered":"<p>The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling, serialization and full CRUD\u00a0 (Create Replace Update Delete) based operations to your database.<\/p>\n<p>Within this article will look at how to create a very basic API. The API will take in a JSON input, validate and return a response back to the client.<\/p>\n<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_65 counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<p class=\"ez-toc-title\">Table of Contents<\/p>\n<label for=\"ez-toc-cssicon-toggle-item-66293d3b24dbe\" class=\"ez-toc-cssicon-toggle-label\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/label><input type=\"checkbox\"  id=\"ez-toc-cssicon-toggle-item-66293d3b24dbe\"  aria-label=\"Toggle\" \/><nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Installing_DRF\" title=\"Installing DRF\">Installing DRF<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Settingspy\" title=\"Settings.py\">Settings.py<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Serializerspy\" title=\"Serializers.py\">Serializers.py<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Viewspy\" title=\"Views.py\">Views.py<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Exceptions\" title=\"Exceptions\">Exceptions<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Examples\" title=\"Examples\">Examples<\/a><ul class='ez-toc-list-level-3' ><li class='ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-7\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Correct_Input\" title=\"Correct Input\">Correct Input<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-8\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Malformed_Input\" title=\"Malformed Input\">Malformed Input<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-9\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\/#Not_Found_Catchall\" title=\"Not Found Catchall\">Not Found Catchall<\/a><\/li><\/ul><\/nav><\/div>\n<h2><span class=\"ez-toc-section\" id=\"Installing_DRF\"><\/span>Installing DRF<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>The first thing you will need to do is install DRF.<\/p>\n<pre class=\"prettyprint\">pip install Django==1.8\u00a0\r\npip install djangorestframework==3.3.2<\/pre>\n<p>Once done, lets create a Django project and app.<\/p>\n<pre class=\"prettyprint\">django-admin startproject myproject\r\ncd myproject\/\r\npython manage.py startapp myapp<\/pre>\n<h2><span class=\"ez-toc-section\" id=\"Settingspy\"><\/span>Settings.py<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Within your settings file add DRF and your new Django app.<\/p>\n<pre class=\"prettyprint\">INSTALLED_APPS = [\r\n+   'rest_framework',\r\n+   'myapp',\r\n...<\/pre>\n<h2><span class=\"ez-toc-section\" id=\"Serializerspy\"><\/span>Serializers.py<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Serializers allow you to build a logical representation of your data, in turn allowing you to,<\/p>\n<ul>\n<li>Convert incoming data from JSON to Python data structures and vice-versa.<\/li>\n<li>Perform data validation, this is\u00a0extremely similar to how the Forms and ModelForm classes work within Django.<\/li>\n<\/ul>\n<p>Below shows you an example. We simply create a serializer, defining a key named &#8217;email&#8217; and a value that must contain a dictionary.<\/p>\n<pre class=\"prettyprint\">from rest_framework import serializers\r\n class MyAPISerializer(serializers.Serializer):\r\n    email = serializers.DictField()<\/pre>\n<p>Once your data has been passed to your serializer <span class=\"codeinline\">serializer.is_valid()<\/span>can be called. Errors can then be returned by calling<span class=\"codeinline\">serializer.errors<\/span>. Below shows can example,<\/p>\n<pre class=\"prettyprint\">serializer = MyAPISerializer(data={'wrong_key': 'bad_value'})\r\nserializer.is_valid()\r\n# False\r\nserializer.errors\r\n# {'email': [u'This field is required.']}<\/pre>\n<h2><span class=\"ez-toc-section\" id=\"Viewspy\"><\/span>Views.py<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Lets next look at <span class=\"codeinline\">views.py<\/span>. First we apply a decorator to only allow GET and POST requests. Our data is then passed to our serializer we check if the data is valid, if it is a HTTP 200 response is returned back to the client. If the data is not valid the error is returned.<\/p>\n<pre class=\"prettyprint\">from rest_framework.decorators import api_view\r\n @api_view(['GET','POST'])\r\ndef myapi(request):\r\n    serializer = MyAPISerializer(data=request.data)\r\n    if serializer.is_valid():\r\n        return Response(serializer.data, status=status.HTTP_200_OK)\r\n    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)<\/pre>\n<h2><span class=\"ez-toc-section\" id=\"Exceptions\"><\/span>Exceptions<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Django DRF contains a number of built in exceptions, such as ParseError, ValidationError and PermissionError. When these exceptions are raised, for example due to malformed input, a JSON response with the appropriate details and response code is returned.<\/p>\n<p>Additionally, these exceptions can be <strong>manually raised<\/strong>. It is also worth noting, at the point of raising a custom exceptions you can also amend the response details returned.<\/p>\n<pre class=\"prettyprint\">raise NotAuthenticated(detail='User not authenticated')<\/pre>\n<p><strong>Custom exceptions<\/strong> can also be created by\u00a0subclassing <span class=\"codeinline\">APIException<\/span>. Below shows an example,<\/p>\n<pre class=\"prettyprint\">from rest_framework.exceptions import APIException\r\n class FluxError(APIException):\r\n    status_code = 503\r\n    default_detail = 'Flux Error. Please check flux capacitor'<\/pre>\n<h2><span class=\"ez-toc-section\" id=\"Examples\"><\/span>Examples<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Based on the previous Django configuration (views, serializers and views) and our new knowledge of the DRF exceptions, lets see some examples. Within our examples we will send the correct input to our API , the incorrect input and then view the returned responses. First all lets run Djangos built in webserver.<\/p>\n<pre class=\"prettyprint\">python manage.py runserver 0.0.0.0:8002 &amp;<\/pre>\n<h3><span class=\"ez-toc-section\" id=\"Correct_Input\"><\/span>Correct Input<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>Next we use httpie to send in a HTTP POST request. Here we provide the <strong>required data<\/strong>, this was previously set within<span class=\"codeinline\">serializer.py<\/span>.<\/p>\n<pre class=\"prettyprint\">echo '{\"email\":{\"john\":\"<span id=\"cloak45b99d94dec59da20d464ce26979f9e6\"><a href=\"mailto:john@xyz.com\">john@xyz.com<\/a><\/span>\"}}' | http \r\n\r\n[10\/Mar\/2016 23:17:24]\"POST \/myapi HTTP\/1.1\" 200 33\r\nHTTP\/1.0 200 OK\r\nAllow: POST, OPTIONS, GET\r\nContent-Type: application\/json\r\nDate: Thu, 10 Mar 2016 23:17:24 GMT\r\nServer: WSGIServer\/0.1 Python\/2.7.5\r\nVary: Accept, Cookie\r\nX-Frame-Options: SAMEORIGIN\r\n\r\n{\r\n    \"email\": {\r\n        \"john\": \"<span id=\"cloak787645622c38d05df085d61a32dd91c0\"><a href=\"mailto:john@xyz.com\">john@xyz.com<\/a><\/span>\"\r\n    }\r\n}<\/pre>\n<h3><span class=\"ez-toc-section\" id=\"Malformed_Input\"><\/span>Malformed Input<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>Now, if we send in some <strong>malformed JSON<\/strong> the DRF raises an exception, this generates a HTTP response with the appropriate error.<br \/>\nBelow the quotes are removed from &#8217;email&#8217;.<\/p>\n<pre class=\"prettyprint\">echo '{email:{\"john\":\"<span id=\"cloak632116c6a57878b24515c29a99180095\"><a href=\"mailto:john@xyz.com\">john@xyz.com<\/a><\/span>\"}}' | http \r\n\r\n[11\/Mar\/2016 20:20:56]\"POST \/myapi HTTP\/1.1\" 400 107\r\nHTTP\/1.0 400 BAD REQUEST\r\nAllow: POST, OPTIONS, GET\r\nContent-Type: application\/json\r\nDate: Fri, 11 Mar 2016 20:20:56 GMT\r\nServer: WSGIServer\/0.1 Python\/2.7.5\r\nVary: Accept, Cookie\r\nX-Frame-Options: SAMEORIGIN\r\n{\r\n    \"detail\": \"JSON parse error - Expecting property name enclosed in double quotes: line 1 column 2 (char 1)\"\r\n}<\/pre>\n<p>Lets change the data that is sent in. We change the input so that the <strong>JSON is different<\/strong> to what is defined within the <span class=\"codeinline\">serializer.py<\/span>.<\/p>\n<pre class=\"prettyprint\">echo '{\"bananas\":{\"john\":\"john@xyz.co\"}}' | http <\/pre>\n<p>[11\/Mar\/2016 20:18:35]&#8221;POST \/myapi HTTP\/1.1&#8243; 400 37<br \/>\nHTTP\/1.0 400 BAD REQUEST<br \/>\nAllow: POST, OPTIONS, GET<br \/>\nContent-Type: application\/json<br \/>\nDate: Fri, 11 Mar 2016 20:18:35 GMT<br \/>\nServer: WSGIServer\/0.1 Python\/2.7.5<br \/>\nVary: Accept, Cookie<br \/>\nX-Frame-Options: SAMEORIGIN {<br \/>\n&#8220;email&#8221;: [<br \/>\n&#8220;This field is required.&#8221;<br \/>\n]<br \/>\n}<\/p>\n<h2><span class=\"ez-toc-section\" id=\"Not_Found_Catchall\"><\/span>Not Found Catchall<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Now everything above is all well and good, but what happens when the client sends in a request for a URI that is not configured within <span class=\"codeinline\">urls.py<\/span> ?<br \/>\nThough a 404 is returned (shown below) the response is not presented as JSON due to the request not making it through to DRF, this is because\u00a0 the error is raised within <span class=\"codeinline\">urls.py<\/span>.<\/p>\n<pre class=\"prettyprint\">echo '{\"email\":{\"john\":\"<span id=\"cloake165fde03373c831999fc895ee9cd505\"><a href=\"mailto:john@xyz.com\">john@xyz.com<\/a><\/span>\"}}' | http http:\/\/127.0.0.1:8002\/wronguri | more\r\n\r\n[19\/Mar\/2016 21:49:39]\"POST \/wronguri HTTP\/1.1\" 404 2036\r\n&lt;!DOCTYPE html&gt;\r\n&lt;html lang=\"en\"&gt;\r\n&lt;head&gt;\r\n&lt;meta http-equiv=\"content-type\" content=\"text\/html; charset=utf-8\"&gt;\r\n&lt;title&gt;Page not found at \/wronguri&lt;\/title&gt;\r\n&lt;meta name=\"robots\" content=\"NONE,NOARCHIVE\"&gt;<\/pre>\n<p>To resolve this a catchall rule is placed within your <span class=\"codeinline\">urls.py<\/span> and assigned to a view that will return the necessary response.<br \/>\nBelow is an example of the configuration,<\/p>\n<pre class=\"prettyprint\">\/\/ views.py\r\nfrom rest_framework.exceptions import APIException,NotFound\r\nfrom rest_framework.decorators import api_view\r\n\r\n@api_view(['GET'])\r\ndef not_found(request):\r\n    raise NotFound('Resource Not Found')\r\n\r\n\/\/ urls.py (placed at the bottom)\r\n+ url(r'^.*$', 'myproject.views.not_found'),<\/pre>\n<p>Lets retest. Now we see that the response is returned as JSON.<\/p>\n<pre class=\"prettyprint\">echo '{\"email\":{\"john\":\"<span id=\"cloak43947f13e77c0f13e4591ec689350a8a\"><a href=\"mailto:john@xyz.com\">john@xyz.com<\/a><\/span>\"}}' | http http:\/\/127.0.0.1:8002\/wronguri\r\n\r\n[19\/Mar\/2016 22:10:44]\"POST \/ HTTP\/1.1\" 404 31\r\nHTTP\/1.0 404 NOT FOUND\r\nAllow: POST, OPTIONS, GET\r\nContent-Type: application\/json\r\nDate: Sat, 19 Mar 2016 22:10:44 GMT\r\nServer: WSGIServer\/0.1 Python\/2.7.5\r\nVary: Accept, Cookie\r\nX-Frame-Options: SAMEORIGIN\r\n{\r\n    \"detail\": \"Resource Not Found\"\r\n}<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling, serialization and full CRUD\u00a0 (Create Replace Update Delete) based operations to your database. Within this article will look at how to create a very basic API. The API will take in a &#8230; <a title=\"How to Build a RESTful API using the Django REST Framework\" class=\"read-more\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\" aria-label=\"Read more about How to Build a RESTful API using the Django REST Framework\">Read more<\/a><\/p>\n","protected":false},"author":2,"featured_media":972,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[37],"tags":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v22.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>How to Build a RESTful API using the Django REST Framework - Fir3net<\/title>\n<meta name=\"description\" content=\"The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling,\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to Build a RESTful API using the Django REST Framework - Fir3net\" \/>\n<meta property=\"og:description\" content=\"The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling,\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\" \/>\n<meta property=\"og:site_name\" content=\"Fir3net\" \/>\n<meta property=\"article:published_time\" content=\"2016-03-28T20:06:00+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-07-31T15:12:19+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png\" \/>\n\t<meta property=\"og:image:width\" content=\"600\" \/>\n\t<meta property=\"og:image:height\" content=\"265\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Rick Donato\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Rick Donato\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\"},\"author\":{\"name\":\"Rick Donato\",\"@id\":\"https:\/\/www.fir3net.com\/#\/schema\/person\/ab35009601b7687ee1c5310be6038037\"},\"headline\":\"How to Build a RESTful API using the Django REST Framework\",\"datePublished\":\"2016-03-28T20:06:00+00:00\",\"dateModified\":\"2021-07-31T15:12:19+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\"},\"wordCount\":616,\"publisher\":{\"@id\":\"https:\/\/www.fir3net.com\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png\",\"articleSection\":[\"Django\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\",\"url\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\",\"name\":\"How to Build a RESTful API using the Django REST Framework - Fir3net\",\"isPartOf\":{\"@id\":\"https:\/\/www.fir3net.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png\",\"datePublished\":\"2016-03-28T20:06:00+00:00\",\"dateModified\":\"2021-07-31T15:12:19+00:00\",\"description\":\"The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling,\",\"breadcrumb\":{\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage\",\"url\":\"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png\",\"contentUrl\":\"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png\",\"width\":600,\"height\":265},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.fir3net.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Programming\",\"item\":\"https:\/\/www.fir3net.com\/programming\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Web Development\",\"item\":\"https:\/\/www.fir3net.com\/programming\/web-development\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Django\",\"item\":\"https:\/\/www.fir3net.com\/programming\/web-development\/django\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"How to Build a RESTful API using the Django REST Framework\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.fir3net.com\/#website\",\"url\":\"https:\/\/www.fir3net.com\/\",\"name\":\"Fir3net\",\"description\":\"Keeping you in the know\",\"publisher\":{\"@id\":\"https:\/\/www.fir3net.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.fir3net.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.fir3net.com\/#organization\",\"name\":\"Fir3net\",\"url\":\"https:\/\/www.fir3net.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.fir3net.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.fir3net.com\/wp-content\/uploads\/Fir3net-Background-Logo-compressed.png\",\"contentUrl\":\"https:\/\/www.fir3net.com\/wp-content\/uploads\/Fir3net-Background-Logo-compressed.png\",\"width\":390,\"height\":88,\"caption\":\"Fir3net\"},\"image\":{\"@id\":\"https:\/\/www.fir3net.com\/#\/schema\/logo\/image\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.fir3net.com\/#\/schema\/person\/ab35009601b7687ee1c5310be6038037\",\"name\":\"Rick Donato\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.fir3net.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d75d69a54c0ca3b32c24c3a9703b623c?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d75d69a54c0ca3b32c24c3a9703b623c?s=96&d=mm&r=g\",\"caption\":\"Rick Donato\"},\"description\":\"Rick Donato is a Network Automation Architect\/Evangelist and the founder of Packet Coders.\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to Build a RESTful API using the Django REST Framework - Fir3net","description":"The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling,","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html","og_locale":"en_US","og_type":"article","og_title":"How to Build a RESTful API using the Django REST Framework - Fir3net","og_description":"The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling,","og_url":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html","og_site_name":"Fir3net","article_published_time":"2016-03-28T20:06:00+00:00","article_modified_time":"2021-07-31T15:12:19+00:00","og_image":[{"width":600,"height":265,"url":"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png","type":"image\/jpeg"}],"author":"Rick Donato","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Rick Donato","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#article","isPartOf":{"@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html"},"author":{"name":"Rick Donato","@id":"https:\/\/www.fir3net.com\/#\/schema\/person\/ab35009601b7687ee1c5310be6038037"},"headline":"How to Build a RESTful API using the Django REST Framework","datePublished":"2016-03-28T20:06:00+00:00","dateModified":"2021-07-31T15:12:19+00:00","mainEntityOfPage":{"@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html"},"wordCount":616,"publisher":{"@id":"https:\/\/www.fir3net.com\/#organization"},"image":{"@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage"},"thumbnailUrl":"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png","articleSection":["Django"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html","url":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html","name":"How to Build a RESTful API using the Django REST Framework - Fir3net","isPartOf":{"@id":"https:\/\/www.fir3net.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage"},"image":{"@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage"},"thumbnailUrl":"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png","datePublished":"2016-03-28T20:06:00+00:00","dateModified":"2021-07-31T15:12:19+00:00","description":"The Django REST Framework (DRF) allows you create REST based APIs quickly and simply, providing a range of features such authentication, error handling,","breadcrumb":{"@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#primaryimage","url":"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png","contentUrl":"https:\/\/www.fir3net.com\/wp-content\/uploads\/2016\/03\/images_drf.png","width":600,"height":265},{"@type":"BreadcrumbList","@id":"https:\/\/www.fir3net.com\/Web-Development\/Django\/how-to-build-a-restful-api-using-the-django-rest-framework.html#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.fir3net.com\/"},{"@type":"ListItem","position":2,"name":"Programming","item":"https:\/\/www.fir3net.com\/programming"},{"@type":"ListItem","position":3,"name":"Web Development","item":"https:\/\/www.fir3net.com\/programming\/web-development"},{"@type":"ListItem","position":4,"name":"Django","item":"https:\/\/www.fir3net.com\/programming\/web-development\/django"},{"@type":"ListItem","position":5,"name":"How to Build a RESTful API using the Django REST Framework"}]},{"@type":"WebSite","@id":"https:\/\/www.fir3net.com\/#website","url":"https:\/\/www.fir3net.com\/","name":"Fir3net","description":"Keeping you in the know","publisher":{"@id":"https:\/\/www.fir3net.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.fir3net.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.fir3net.com\/#organization","name":"Fir3net","url":"https:\/\/www.fir3net.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.fir3net.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.fir3net.com\/wp-content\/uploads\/Fir3net-Background-Logo-compressed.png","contentUrl":"https:\/\/www.fir3net.com\/wp-content\/uploads\/Fir3net-Background-Logo-compressed.png","width":390,"height":88,"caption":"Fir3net"},"image":{"@id":"https:\/\/www.fir3net.com\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/www.fir3net.com\/#\/schema\/person\/ab35009601b7687ee1c5310be6038037","name":"Rick Donato","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.fir3net.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/d75d69a54c0ca3b32c24c3a9703b623c?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d75d69a54c0ca3b32c24c3a9703b623c?s=96&d=mm&r=g","caption":"Rick Donato"},"description":"Rick Donato is a Network Automation Architect\/Evangelist and the founder of Packet Coders."}]}},"_links":{"self":[{"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/posts\/973"}],"collection":[{"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/comments?post=973"}],"version-history":[{"count":0,"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/posts\/973\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/media\/972"}],"wp:attachment":[{"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/media?parent=973"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/categories?post=973"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.fir3net.com\/wp-json\/wp\/v2\/tags?post=973"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}