如何在 django 中构建 json REST API（没有 Django REST 框架）

Question

Preface

I have a django project. I've wired it up so it serves a bunch of views for a bunch of models. Now I want to add an endpoint which just dumps a good fraction of the database out as json.

The way I would assume you do this is add a URL to a view class / method which returns a HTTPResponseObject full of json. Unfortunately, after quite a bit of googling, all I can find are references to Django REST framework . This is the sort of thing you would think Django would provide internally not as part of an external plugin library. But searching the django docs doesn't yield an immediate answer -- I don't think there are any docs about how to build an endpoint which just serves a bunch of json.

Questions:

• Do I really need "Django REST framework" to serve json in django?
• Did I overlook docs in Django for serving json?
• What is the canonical way to serve json in a django project?

Answer 1

After more googling, I found what I was looking for in the Django docs: JsonResponse

from django.http import JsonResponse
return JsonResponse({'foo':'bar'})

I think googling using the word "REST" was kind of a red herring which made the search space always direct my queries towards "Django REST framework" which is not what I wanted, though I do want to add a RESTful API.

Answer 2

You can write GET API using this method, but for POST method this will not work. For Post method we need to use some REST Library.

POST Method will check for CSRF token in the cookies and where it fails to execute the request, as your django server will treat this request as forged.

Answer 3

You should go with Django Rest Framework but if you want to do it yourself then:

1. For POST request, if the client is sending you data as JSON, then you can use the json module to read the data from the request body.

import json

def add_new_user(self, request):
    data = request.body.decode('utf8')
    data = json.loads(data)

2. If plain name/value pair is sent, then use request.POST or request.GET

3. Use JsonResponse to send the response

4. After authentication, the server usually send a token to the client. The client then sends that token when sending a request to 'protected' api end-point. A custom header (like auth_token) is used to send the token.

In the server code, you need to do something like request.META['HTTP_AUTH_TOKEN'] to get the token (see Custom HTTP Header in Django )

There are more things to consider like CSRF token or JWT.

See this site for a complete examplehttps://jee-appy.blogspot.com/2018/02/make-rest-api-django.html . Be warned, it use old version of django.