Django: TemplateDoesNotExist (rest_framework/api.html)

Question

In my view function, I'd like to return a json object (data1) and some text/html (form). Is this possible?

MY code

@api_view(['POST'])
@permission_classes((AllowAny,))
def create_user(request):
    if request.is_ajax():
        if request.method == 'POST':
            serializer = SignupSerializer(data=request.data)
            print 'ser'
            print serializer
            if not serializer.is_valid():
                return Response(serializer.errors,\
                                status=status.HTTP_400_BAD_REQUEST)
            else:
                serializer.save()
                data={'status': 'Created','message': 'Verification email has been sent to your email. Please verify your account.'}
                return Response(data, template_name='register.html')
    else:
        return HttpResponse('hello world')

When I call the url I get status code 500 with error as displayed below

TemplateDoesNotExist rest_framework/api.html

when I check as a API, I get response with 200 ok status. This shows Im unable to get my html page

How should I get my html depending on request?

Linovia · Accepted Answer · 2016-07-14 07:23:52Z

457

Make sure you have rest_framework in your settings's INSTALLED_APPS

answered Jul 14, 2016 at 7:23

Linovia

21.1k4 gold badges53 silver badges51 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Coeus Over a year ago

Its already present. I believe @api_view is not allowing me to render html page..Is there any other solution

Linovia Over a year ago

You want to double check that by opening the django shell and looking at the INSTALLED_APPS. It's unlikely api_view since I got it working and it would return an HTTP 415 Unsupported Media Type.

Coeus Over a year ago

this function works with CURL command, I also get response, when i try to render html with my browser, I get the above listed error

niran Over a year ago

This should be selected has answer?

sarath kumar · Accepted Answer · 2019-04-08 19:49:01Z

97

Make sure you install pip install djangorestframework and include rest_framework in the setting.py

INSTALLED_APPS = [
    'rest_framework',
]

answered Apr 8, 2019 at 19:49

sarath kumar

1,47513 silver badges7 bronze badges

Comments

Community · Accepted Answer · 2020-06-20 09:12:55Z

This is my attempt to explain the problem and collect everyone else's responses into a single list. Thanks to everyone for giving me shoulders to stand on!

I believe this happens because Django REST Framework wants to render a template (rest_framework/api.html), but the template can't be found. It seems there are two approaches to fix this:

Approach 1: Make templates work

Ensure REST Framework is included in INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    ...
    'rest_framework',
    ...
]

And ensure APP_DIRS is True in your template configuration (it defaults to False if not specified). This allows Django to look for templates in installed applications. Here's a minimal configuration that seems to work, though you might have more config here:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'APP_DIRS': True,
    },
]

Approach 2: Return a JSON response

If you tell REST Framework to render a JSON response then it doesn't need to use a template so you don't need to change the APP_DIRS settings as mentioned above. It also seems like you might not even need to list rest_framework in INSTALLED_APPS, though it might be necessary to have it there for other reasons.

You can do this globally in settings.py:

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
    ]
}

Or if you're using the @api_view decorator then you can specify JSONRenderer on each view:

@api_view(['GET'])
@renderer_classes([JSONRenderer])
def some_view(request):
    return Response({'status': 'yay'})

See the REST Framework renderers documentation for details.

technology issue nepal · Accepted Answer · 2020-09-15 02:40:10Z

28

I also had same kind of problem. Make sure you have rest_framework installed in your setting in "installed apps"

answered Sep 15, 2020 at 2:40

technology issue nepal

3894 silver badges5 bronze badges

Comments

p kushwaha · Accepted Answer · 2022-03-02 05:03:41Z

16

''' Try one of these for sure help you out:

1: add rest_framework to settings.py app list, sometime order in which your applications are listed may be the reason. '''

INSTALLED_APPS = [
    'rest_framework',
    ...
]

''' 2: review your template settings. See Backend, DIR and APP_DIRS. in case you have customized the rest-framework template please check if the path you have defined is correct, make APP_DIRS: True . In most of the cases this will resolve. '''

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR, os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        ....
    }
]

''' 3: check the default renderer classes settings: '''

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.JSONRenderer',
        ...
    ]
}

''' 4: If you are using api_view decorators on function based view make sure you have provided renderers correctly. i.e.

@renderer_classes([JSONRenderer]) '''

edited Mar 2, 2022 at 5:03

answered Mar 2, 2022 at 4:57

p kushwaha

4173 silver badges10 bronze badges

1 Comment

Ragav Y Over a year ago

At last! 24 hrs of intense hunt later, I find this as the solution that worked for me. Thanks!

Jeremy Caney · Accepted Answer · 2021-09-17 03:18:29Z

14

Make sure that you added rest_framework in your installed_apps to your settings.py file:

INSTALLED_APPS = [
    'rest_framework',
]

edited Sep 17, 2021 at 3:18

Jeremy Caney

7,808115 gold badges58 silver badges86 bronze badges

answered Sep 16, 2021 at 19:08

coding360

1711 silver badge2 bronze badges

Comments

Ross Rogers · Accepted Answer · 2017-12-21 18:54:31Z

12

I hit this issue when upgrading from an old Django version to Django 2.0. My settings.py did not have a TEMPLATE directive at all, so I snagged the following from a new django-admin.py startproject ... run:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

Add that to your settings.py if you don't have TEMPLATES directive in your settings.py. Worked for me.

answered Dec 21, 2017 at 18:54

Ross Rogers

24.4k28 gold badges115 silver badges175 bronze badges

1 Comment

abkonsta Over a year ago

Specifically, in my case, 'APP_DIRS': True got overlooked; that fixed my issue.

Bhardwaj Vishal · Accepted Answer · 2020-07-04 06:02:55Z

11

I have come across the same issue and found out that rest_framework wasn't added to the installed apps in settings.py. Adding it resolved my issue.

answered Jul 4, 2020 at 6:02

Bhardwaj Vishal

1131 silver badge3 bronze badges

Comments

Divyesh pal · Accepted Answer · 2023-08-07 05:41:48Z

6

setting.py add rest_framework , if rest_framework is not added

Ex:

INSTALLED_APPS = ["rest_framework"]

edited Aug 7, 2023 at 5:41

Divyesh pal

9471 gold badge11 silver badges17 bronze badges

answered Jul 25, 2023 at 4:41

mir4zul

591 silver badge4 bronze badges

1 Comment

Utsav T Over a year ago

Why is this needed though ?

CPlus · Accepted Answer · 2023-11-27 23:12:49Z

4

In installed apps if you used rest_framework in your project add rest_framework in setting.py file:

INSTALLED_APPS = [
    'rest_framework',]

edited Nov 27, 2023 at 23:12

CPlus

5,11048 gold badges33 silver badges77 bronze badges

answered Nov 24, 2023 at 14:25

Praveen

391 bronze badge

Comments

Odewole Olusegun · Accepted Answer · 2021-12-16 17:16:00Z

3

The order of the installed apps matters a lot. In my case i added 'rest_auth' above 'rest_framework' so it gave this error but when i reordered it ('rest_framework' above 'rest_auth', 'rest_auth.registration', 'rest_framework.authtoken' etc), this error cleared.

sample Proper order below:

INSTALLED_APPS = [

...
'rest_framework',
'rest_auth',
'rest_auth.registration',
'rest_framework.authtoken',
...

]

Thanks.

answered Dec 16, 2021 at 17:16

Odewole Olusegun

662 bronze badges

Comments

Juwaini · Accepted Answer · 2017-03-14 04:55:36Z

2

Other than adding 'rest_framework' inside your INSTALLED_APPS, try adding the following inside your TEMPLATES.OPTIONS:

'loaders': [
     'django.template.loaders.filesystem.Loader',
     'django.template.loaders.app_directories.Loader'
],

edited Mar 14, 2017 at 4:55

answered Mar 14, 2017 at 3:51

Juwaini

363 bronze badges

Comments

Duc Tran · Accepted Answer · 2019-10-02 10:13:49Z

1

Adding this decorator above that view @renderer_classes([JSONRenderer])

answered Oct 2, 2019 at 10:13

Duc Tran

111 bronze badge

Comments

Dotun Peter · Accepted Answer · 2020-10-23 22:09:16Z

1

instead of using HttpResponse, use:

from rest_framework.response import Response

return Response(data=message, status=status.HTTP_200_OK)

answered Oct 23, 2020 at 22:09

Dotun Peter

611 silver badge7 bronze badges

Comments

Rajat Jog · Accepted Answer · 2024-02-21 13:08:51Z

1

I faced a same issue. But I installed django_filters and did not included it in INSTALLED_APPS. After putting it in INSTALLED_APPS, it worked. So look for other third party apps as well.

answered Feb 21, 2024 at 13:08

Rajat Jog

3271 gold badge2 silver badges11 bronze badges

1 Comment

Ehsan88 Mar 3 at 2:50

Note that you should add rest_framework before django_filters in INSTALLED_APPS

Nickolai Kozhenin · Accepted Answer · 2019-04-26 06:12:49Z

-1

I have came across the same problem, I was sending an empty response. Try to put a different infomation into Response() in create_user function to check if it works at all

answered Apr 26, 2019 at 6:12

Nickolai Kozhenin

911 silver badge4 bronze badges

Collectives™ on Stack Overflow

Django: TemplateDoesNotExist (rest_framework/api.html)

16 Answers 16

4 Comments

Comments

Approach 1: Make templates work

Approach 2: Return a JSON response

Comments

Comments

1 Comment

Comments

1 Comment

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

16 Answers 16

4 Comments

Comments

Approach 1: Make templates work

Approach 2: Return a JSON response

Comments

Comments

1 Comment

Comments

1 Comment

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related