PythonのREST APIから取得したJSONデータをHTML上に埋め込んで表示したい

Question

前提・実現したいこと

Pythonでdjangorestframeworkを使用してデータベースから読み込んだデータをJSON形式で返す処理を作成しています。
上記のREST APIは実際にWebブラウザ上で指定のアドレスへアクセスすればデータが出力されていることを確認しています。
jQueryを用いて上記のREST APIからJSONデータを受け取ってHTMLページへ埋め込む処理を作りたいです。

Python 3.6
Django 2.0.5
django-cors-headers 2.2.0
django-filter 1.1.0
djangorestframework 3.8.2

発生している問題・エラーメッセージ

実際にjQueryのajaxを使用して取得しようとすると以下のエラーが発生してしまいます。

Error: jQuery1800804225095946975_1526269266370 was not called
at Function.error (eval at <anonymous> (jquery-1.8.0.min.js:2), <anonymous>:2:13145)
at c.converters.script json (eval at <anonymous> (jquery-1.8.0.min.js:2), <anonymous>:2:83347)
at cC (eval at <anonymous> (jquery-1.8.0.min.js:2), <anonymous>:2:5874)
at y (eval at <anonymous> (jquery-1.8.0.min.js:2), <anonymous>:2:79888)
at HTMLScriptElement.c.onload.c.onreadystatechange (eval at <anonymous> (jquery-1.8.0.min.js:2), <anonymous>:2:84323)

ただ、Google ChromeのDevTools上でヘッダは200 OKが出ていて、ResponseでもJSONのデータが受け取ることが出来ていますが、ajaxはエラーになってしまいます。

該当のソースコード

・Settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'corsheaders',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
]

CORS_ORIGIN_WHITELIST = (
    'localhost:8000',
    '127.0.0.1:8000'
)
CORS_ORIGIN_REGEX_WHITELIST = (
    'localhost:8000',
    '127.0.0.1:8000'
)
CORS_ORIGIN_ALLOW_ALL = True

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    ),
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework.parsers.JSONParser',
    )
}

・ajax_test/urls.py

from django.contrib import admin
from django.urls import path
from django.conf.urls import url, include
from test_dir.urls import router as test_router

urlpatterns = [
    path('admin/', admin.site.urls),
    url(r'^api/', include(test_router.urls)),
]

・test_dir/urls.py

from rest_framework import routers
from .views import TestAPIViewSet

router = routers.DefaultRouter()
router.register(r'test', TestAPIViewSet)

・test_dir/model.py

from django.db import models
from rest_framework.views import APIView
from urllib.parse import urlparse
import mysql.connector
from rest_framework.response import Response

class TestAPI(models.Model):
    id = models.IntegerField('id')
    name = models.CharField('name',max_length=20)
    value = models.IntegerField('value')
    class Meta:
        app_label = "TestAPI"
        db_table = "test"

・test_dir/serializer.py

from rest_framework import serializers
from .models import TestAPI

class TestAPISerializer(serializers.ModelSerializer):
    class Meta:
        model = TestAPI
        fields = ('id', 'name', 'value')

・views.py

import django_filters
from rest_framework import viewsets, filters

from .models import TestAPI
from .serializer import TestAPISerializer

from django.http import JsonResponse

class TestAPIViewSet(viewsets.ModelViewSet):
    queryset = TestAPI.objects.all()
    serializer_class = TestAPISerializer
    base_url = '/api/test/'

def DBDataRes(request):
    json_ary = []
    c = connections['default']
    cursor = c.cursor
    try:
        cursor.execute('select id, name, value from test')
        results = cursor.fetchall()
        for result in results.order_by('id'):
            dict = OrderedDict(
                ('id', result.id),
                ('name', result.name),
                ('value', result.value)
            )
            json_ary.append(dict)

        c.commit()
        return JsonResponse(json_ary)
    except Exception as err:
        c.rollback()
        raise err
    finally:
        cursor.close()
        c.close()

・ajaxtest.js

var ajax_test = function () {
    alert('start');
    $.ajax({
        url: 'http://localhost:8000/api/test',
        type: 'GET',
        data: {
        },
        dataType: 'jsonp',
    })
        .done(function(data){
            data.foreach(function (datum) {
                $('#ajax_result').append('<div><div><div>id</div><div>' + datum.id + '</div></div><div><div>name</div><div>' + datum.name + '</div></div><div><div>value</div><div>' + datum.value + '</div></div></div>');
            })
        })
        .fail(function(xhr, textStatus, errorThrown){
            alert('fail');
        })
};


//初期処理
$(function () {
    document.getElementById('btn_test').addEventListener('click', function () {
        ajax_test();
    }, false);
});

Answer 1

大変頓珍漢な結果で申し訳ありませんが、
Apache上のajaxtest.htmlから
Apacheとは別に起動していたPython上のREST APIへ接続していたことで発生していたCORSが原因でした。

現時点でajaxtest.htmlとREST APIは別々のサーバにする必要はないので、
ajaxtext.htmlの内容をPython側のテンプレートに移植して、
Python上のWebページからAjaxを実行することで（JavaScript側も一部修正が必要でしたが）REST APIのデータをJavaScriptで受けることが出来ました。

大変失礼致しました。有難うございました。

修正後は以下の通りになります。

・Settings.py

#ajaxtest.jsなどの固定で読み込むファイルの設置ディレクトリ定義
STATIC_URL = '/static/'
STATICFILES_DIRS = (
    os.path.join(BASE_DIR, 'static'),
)

・JavaScriptやCSSを入れるstaticディレクトリ及びtemplatesディレクトリの追加
/
├ajax_test
├test_dir
│└templates
├static
│├scripts
│├css
││

・ajax_test/urls.py

（省略）
urlpatterns = [
（中略）
    #test_dir/urls.pyへの参照追加
    path('test/', include('test_dir.urls')),
]

・test_dir/urls.py

（省略）
from django.urls import path
from . import views
（中略）
#ajaxtest.htmlのWebページ定義追加
urlpatterns = [
    path('testpage/', views.TestPage.as_view(), name='testpage'),
]

・test_dir/views.py

from django.views import generic
（中略）
#ajaxtest.htmlを移植したテンプレートの定義
class TestPage(generic.TemplateView):
    template_name = 'ajaxtest.html'

・test_dir/templates/ajaxtest.html

{% load staticfiles %}
<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <link rel="stylesheet" type="text/css" href="{% static 'css/index.css' %}">
    <link rel="stylesheet" type="text/css" href="{% static 'css/jquery-ui.css' %}">
    <title>Ajaxのテストページ</title>
</head>
<body>
    <div id="btn_test" class="div_link">データ取得</div>
    <div>テスト結果</div>
    <div id="ajax_result"></div>
    <script type="text/javascript" src="{% static 'scripts/ajaxtest.js' %}"></script>
    <script type="text/javascript" src="{% static 'scripts/jquery-ui.min.js' %}"></script>
</body>
</html>

・static/srcipts/ajaxtest.js

var ajax_test = function () {
    //dataTypeの修正
    $.ajax({
        url: 'http://localhost:8000/api/test',
        type: 'GET',
        data: {
        },
        dataType: 'json',
    })
        .done(function(data){
            alert('done');
            console.log(data);
            //ForEach文の修正
            for(var n = 0; n < data.length - 1; n++){
            	var datum = data[n];
            	$('#ajax_result').append('<div><div><div>id</div><div>' + datum.id + '</div></div><div><div>name</div><div>' + datum.name + '</div></div><div><div>value</div><div>' + datum.value + '</div></div></div>');
            }
        })
        .fail(function(xhr, textStatus, errorThrown){
            alert('fail');
        })
};

$(function () {
    document.getElementById('btn_test').addEventListener('click', function () {
        ajax_test();
    }, false);
});

Answer 2

JSON を確実に返しているのであればバックエンドの Python は特に精査する必要はないと思います。
むしろ、その JSON と JavaScript の挙動が気になるので、DOM操作をしている以下の部分を

.done(function(data){
  console.log(data); // <- 追加
  data.foreach(function (datum) {
    $('#ajax_result').append('<div><div><div>id</div><div>' + datum.id + '</div></div><div><div>name</div><div>' + datum.name + '</div></div><div><div>value</div><div>' + datum.value + '</div></div></div>');
  })
})

のようにして表示された JSON を見せてもらえないでしょうか。

ちなみに jQuery は久しく使っていないのですが、 JSON が返ってくるのであれば ajax の dataType: json が正しいのではないでしょうか。

Comments

[shimeji_forest]

実はconsole.log(data);を埋め込んでも.done()へ辿り着く前にエラーが発生していた為、JavaScript側ではJSONを確認出来ない状態でした。
ちなみに、REST APIで取得した場合、
[{"id":1,"name":"あ","value":100},{"id":2,"name":"い","value":-50},{"id":3,"name":"う","value":20}]
と返って来る様になっていました。

ajaxはご指摘頂いた通りで、dataType: jsonが正しかったです。有難うございました。

[og24715]

CORS が原因でリクエスト失敗しているのであれば 4xx 系のレスポンスが返りそうですけど不思議ですね

[shimeji_forest]

私自身理解不足であるということで申し訳ない面があるのですが、調べ直すとCORSの問題という認識が誤りであり、サーバ側でレスポンスヘッダにクロスドメイン要求を許可する設定が必要なのに現時点で入れていないことが本当の原因の様な気がしてきました。

ajaxのdataTypeをjsonに修正した状態でHTTPステータスコードを確認してみましたが、この場合は301 Moved Permanentlyが返って来ていて、
コンソール上では以下の様に表示されていました。

Failed to load http://localhost:8000/api/test: Redirect from 'http://localhost:8000/api/test' to 'http://localhost:8000/api/test/' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost' is therefore not allowed access.

今は自分の環境内でAjaxを用いたREST APIのテストを行うことが目的だったので自己解決時のソースでも問題ないのかもしれませんが、もしかしたらviewsの一部を

response = HttpResponse(json_ary, content_type="application/json")
response["Access-Control-Allow-Origin"] = "*"
return response

という感じへ書き替えるべきかもしれません。