Django PrettyJSON 项目教程

Django PrettyJSON 项目教程

django-prettyjson Enables pretty JSON viewer in Django forms, admin, or templates 项目地址: https://gitcode.com/gh_mirrors/dj/django-prettyjson

1. 项目介绍

django-prettyjson 是一个用于在 Django 项目中展示 JSON 数据的工具。它提供了一个美观的 JSON 查看器，可以在 Django 的表单、管理界面或模板中使用。该工具基于 jQuery JSONView 开发，支持几乎所有类型的 JSON 数据展示，包括存储在字符串中的 JSON、使用 django.contrib.postgres 或 django-jsonfield 的 JSONField，以及任何可以序列化为 JSON 的 Python 对象。

2. 项目快速启动

安装

首先，使用 pip 安装 django-prettyjson：

pip install django-prettyjson

配置

在 Django 项目的 settings.py 文件中，将 prettyjson 添加到 INSTALLED_APPS：

INSTALLED_APPS = (
    ...
    'prettyjson',
    ...
)

使用

在表单或管理界面中使用

在表单或管理界面中，可以通过 PrettyJSONWidget 来启用美观的 JSON 查看器。例如，在管理界面中：

from prettyjson import PrettyJSONWidget
from django.contrib import admin
from django.contrib.postgres.fields import JSONField
from .models import Test

class JsonAdmin(admin.ModelAdmin):
    formfield_overrides = {
        JSONField: {'widget': PrettyJSONWidget}
    }

admin.site.register(Test, JsonAdmin)

在模板中使用

在模板中，可以使用 prettyjson 模板标签来展示 JSON 数据。首先，确保在模板中加载 prettyjson 标签，并包含必要的 CSS 和 JS：

{% extends "base.html" %}
{% load prettyjson %}

{% block header %}
    {{ block.super }}
    {% prettyjson_setup %}
{% endblock %}

{% block content %}
    {% prettyjson myqueryset %}
    {% prettyjson mydict %}
    {% prettyjson '["hey": "guy", "anumber": 243, "anobject": ["whoa": "nuts", "anarray": [1, 2, "thr<h1>ee"], "more":"stuff"], "awesome": true, "bogus": false, "meaning": null, "japanese":"明日がある", "link": "http://jsonview.com", "notLink": "http://jsonview.com is great"]' %}
    {% prettyjson '[]' %}
{% endblock %}

3. 应用案例和最佳实践

应用案例

• API 响应展示：在开发和调试阶段，使用 django-prettyjson 可以方便地展示 API 响应的 JSON 数据，帮助开发者快速定位问题。
• 配置管理：在管理界面中展示复杂的配置数据，如 API 密钥、权限设置等，使用 django-prettyjson 可以使这些数据更易于阅读和理解。

最佳实践

• 初始渲染配置：默认情况下，JSON 数据会以原始字符串形式展示，用户需要点击按钮才能查看解析后的 JSON。可以通过设置 initial='parsed' 参数，使 JSON 数据在初始状态下就以解析后的形式展示。

class JsonAdmin(admin.ModelAdmin):
    formfield_overrides = {
        JSONField: {'widget': PrettyJSONWidget(attrs={'initial': 'parsed'})}
    }

• 避免重复加载 jQuery：如果你的页面已经包含了 jQuery，可以使用 {% prettyjson_setup jquery=False %} 来避免重复加载 jQuery。

4. 典型生态项目

• Django REST Framework：django-prettyjson 可以与 Django REST Framework 结合使用，方便地展示 API 响应的 JSON 数据。
• Django Admin：在 Django 管理界面中，django-prettyjson 可以用于展示复杂的数据结构，如 JSONField 中的数据。
• Django Debug Toolbar：在开发过程中，结合 Django Debug Toolbar 使用 django-prettyjson，可以更方便地查看和调试 JSON 数据。

通过以上步骤，你可以快速上手并使用 django-prettyjson 来美化你的 Django 项目中的 JSON 数据展示。

django-prettyjson Enables pretty JSON viewer in Django forms, admin, or templates 项目地址: https://gitcode.com/gh_mirrors/dj/django-prettyjson