DRF Docs 模板定制完全手册：覆盖 6 个默认 Block，打造品牌级 API 文档外观

DRF Docs 模板定制完全手册覆盖 6 个默认 Block打造品牌级 API 文档外观【免费下载链接】django-rest-framework-docsDocument Web APIs made with Django Rest Framework项目地址: https://gitcode.com/gh_mirrors/dj/django-rest-framework-docsDRF Docsdjango-rest-framework-docs是一款为 Django REST Framework 自动生成的 Web API 文档添加美观文档页面的开源工具。只需一行配置你的接口列表、字段说明、请求方法就会变成可折叠的优雅面板。本手册将带你覆盖它的 6 个默认模板 Block样式、标题、Logo、Jumbotron、页脚、GitHub 徽章用不到 30 行模板代码就能把默认外观改造成属于你自己品牌的 API 文档站。为什么需要定制 DRF Docs 模板默认模板虽然好看但标题、Logo、版权信息都是别人家的。如果你把文档开放给客户或团队成员品牌级的外观能显著提升专业感。DRF Docs 的作者特意把页面拆成了 6 个可覆盖的 Block你无需 fork 源码只要新建一个继承模板即可。一键创建你的覆盖模板最快上手步骤1️⃣ 在你的 Django 项目templates/目录下新建rest_framework_docs/docs.html2️⃣ 文件第一行继承默认模板{% extends rest_framework_docs/base.html %}3️⃣ 保存后刷新文档页面Django 会自动加载你的版本。就这么简单 模板查找机制Django 优先加载你自己项目templates/下的同名模板因此同名文件天然覆盖了包内置模板。6 个默认 Block 全覆盖清单默认模板位于rest_framework_docs/templates/rest_framework_docs/base.html共定义了 9 个 Block其中 6 个是定制外观的核心Block作用典型用途style引入 CSS 样式表换成自己的主题样式文件title浏览器标签页标题改为XX 项目 API 文档logo导航栏左侧品牌区放自己的 Logo 和站点名jumbotron顶部大标题横幅自定义文档主标题与副标题footer页面底部版权区换成公司版权信息github_badge右上角 GitHub 徽章置空即可隐藏徽章逐个覆盖复制即用的小片段① 样式style——换肤的入口{% block style %} link relstylesheet href{% static css/my-theme.css %} {% endblock %}② 标题title——浏览器标签页的名字{% block title %}My Project API 文档{% endblock %}③ Logo——导航栏品牌区{% block logo %} a classnavbar-brand href/My Project/a {% endblock %}④ Jumbotron——文档的门面{% block jumbotron %} div classjumbotron h1My Project Web API/h1 h3面向开发者的接口文档。/h3 /div {% endblock %}⑤ Footer——版权与联系方式{% block footer %} div classfooterdiv classlinks/divCopyright © 2026 My Company./div {% endblock %}⑥ 隐藏 GitHub 徽章github_badge——一个空块就够了{% block github_badge %}{% endblock %}进阶定制改主题色比写 CSS 更快如果你不满足于贴一层 CSS可以直接修改 Less 源码。官方样式源文件在rest_framework_docs/static/rest_framework_docs/less/style.less前 20 行就是完整色板GetColor: #18bc9c; // GET 方法标签色 PostColor: #f39c12; // POST 方法标签色 DeleteColor: #e74c3c; // DELETE 方法标签色 BgColor: #FEFEFE; // 页面背景色把GetColor改成你的品牌主色重新编译一次整个文档的方法标签、按钮、高亮色全部跟着变——这就是品牌级外观的最短路径。完整示例一个文件搞定全部定制把上面的片段合并就是一个完整的品牌模板对应文档中的 Complete Example 章节{% extends rest_framework_docs/base.html %} {% block title %}Project Name{% endblock %} {% block logo %}a classnavbar-brand href#Project Name API Documentation/a{% endblock %} {% block github_badge %}{% endblock %} {% block jumbotron %} div classjumbotron h1Project Name Web API/h1 h3Documentation of the Project Name Web API./h3 /div {% endblock %} {% block footer %}div classfooterCopyright © 2026 Project Name./div{% endblock %}文件放在templates/rest_framework_docs/docs.html即可生效。常见问题 FAQQ改完模板页面没变化检查两点一是目录必须叫templates/rest_framework_docs/docs.html二是文件开头必须有{% extends rest_framework_docs/base.html %}。Q只想隐藏徽章不想动别的只写一个空的github_badgeBlock 就行其余部分保持默认。Q如何在生产环境关闭文档在settings.py中设置REST_FRAMEWORK_DOCS {HIDE_DOCS: True}支持用环境变量区分环境详见docs/settings.md。Q接口列表区域content能自定义吗可以。接口面板渲染在rest_framework_docs/templates/rest_framework_docs/home.html的contentBlock 中如需调整分组和折叠面板结构可覆盖该模板。小结✅ 新建一个继承模板文件即可覆盖全部 6 个默认 Block✅ 标题、Logo、Jumbotron、页脚、样式、徽章徽章各有分工按需覆盖✅ 改品牌色最快路径直接调 Less 变量一次编译全站换肤DRF Docs 的模板机制让你几乎零成本就能拥有品牌级 API 文档外观——现在就去给你的接口文档换上新装吧【免费下载链接】django-rest-framework-docsDocument Web APIs made with Django Rest Framework项目地址: https://gitcode.com/gh_mirrors/dj/django-rest-framework-docs创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考