Django Rest Framework - 实例PartyDemo 之 API文档
来源:互联网 发布:linux syslink命令 编辑:程序博客网 时间:2024/05/16 11:09
1.文档选择
在官网上 推荐了两种API文档方案 DRF Docs 和 Swagger 。
DRF Docs 界面预览: 官方文档 :http://drfdocs.com/installation/
Swagger 界面预览 : 官方文档 : http://marcgibbons.github.io/django-rest-swagger/
两个各有千秋,不过我喜欢颜值高的 DRF Docs。
官方文档安装配置十分详细哦
2.DRF 文档安装
1. 安装 module
pip install drfdocs
2.配置 module
mysite/setting.py
INSTALLED_APPS = ( ... 'rest_framework_docs',)
3.url 配置
mysite/urls.py
urlpatterns = [ ... url(r'^docs/', include('rest_framework_docs.urls')),]
4.重写界面样式
重写是在你要使用的api 模块的下面,重新实现rest_framework_docs 下 docs.html 文档即可。
比如我的docs.html :
{% extends "rest_framework_docs/base.html" %}{% block title %}Mysite API {% endblock %}{% block style %} {% load static %} <link rel="stylesheet" href="{% static "rest_framework_docs/css/style.css" %}">{% endblock %}{% block logo %}<a class="navbar-brand" href="#">Mysite API Documentation</a>{% endblock %}{% block jumbotron %} <div class="jumbotron"> <h1>'Mysite ' Web API</h1> <h3>Documentation of the 'Mysite ' Web API.</h3> </div>{% endblock %}{% block footer %} <div class="footer">Copyright © 2016 Mysite .</div>{% endblock %}>
5.重写静态文件 css
界面中加载静态的 css 文件
(1) 配置setting.py
STATIC_URL = '/static/'
(2)实现
{% load static %} <link rel="stylesheet" href="{% static "rest_framework_docs/css/style.css" %}">
(3) 使用 先 load 后 link
效果:
项目地址 :
https://github.com/LABELNET/django-mysite-frist
0 0
- Django Rest Framework - 实例PartyDemo 之 API文档
- Django Rest Framework - 实例PartyDemo 之 增删改查
- Django Rest Framework - 实例PartyDemo 之 用户相关
- Django Rest Framework - 实例PartyDemo 之 Token验证
- Django REST framework API
- Django REST framework API开发
- django rest framework--quickstart[中文文档]
- Django Rest FrameWork 全部API简述
- 利用 Django REST framework 编写 RESTful API
- Django笔记 Django REST Framework实现Web API 1
- [django]禁用 Django Rest Framework 的 Browsable API
- Django REST framework(官方教程之四)
- Django-Rest-Framework 教程: 5. 提高关联性和超链接API
- python调试django-rest-framework API的小工具--httpie
- Django Rest Framework 3.3.2 开发 RESTful API
- Django rest framework API Guide的 Requests 翻译
- Django rest framework API Guide的 Responses 翻译
- Django rest framework API Guide的 Views 翻译
- 《iOS 7 Human Interface Guidelines中文版》读书笔记(1)
- Keras深度学习框架windows端详细配置(吐血)
- 将文件夹的所有word名全部复制到文档里
- Linux打补丁常用命令
- [算法]详解关键路径算法
- Django Rest Framework - 实例PartyDemo 之 API文档
- C++ vector 赋值
- 微信小程序正式发布,一分钟了解什么是小程序!
- SpringMVC数据校验
- Spring Bean扩展接口 -- ApplicationContextAware源码分析
- 安卓.9.png图片制作
- 使用geronimo-javamail_1.4发送邮件的有关说明
- 【中级】2017项目集成管理工程师备考第五章-立项管理(下)
- 《iOS 7 Human Interface Guidelines中文版》读书笔记(2)