Django Rest Framework - 实例PartyDemo 之 API文档

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

Django Rest Framework - 实例PartyDemo 之 API文档相关推荐

【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
Django Rest Framework - 实例PartyDemo 之增删改查
1.配置URL 使用上篇的Partymodel和PartySeralization 在testrestapi下新建 urls.py testresrapi/urls.py urlpatterns = ...
Eureka API文档
目录 REST API 文档 REST API 实战查询所有应用实例根据 AppId 查询根据 AppId 及 instanceId 查询根据 instanceId 查询注册新应用实例注销 ...
Django系列(1)-自动化生成API文档
PS: 个人深感python开发者社区氛围比安卓/ios/java差多了.不过,这也许是个机会- 前提: 本人开发环境是mac10.14.4,Python3.7.2 django-rest-swagg ...
django restful 请求_利用 Django REST framework 构建 RESTful Web API
利用 Django REST framework 构建 RESTful Web API 终于到了动手操作的环节啦,这一节,我们以师生管理系统为例,带领大家搭建一套 framework Web API. ...
wordpress rest api 登录_Python构建RESTful网络服务[Django篇：生成API文档]
链接:https://pan.baidu.com/s/15Mo9adr4Iw2W-um7WK68jA 提取码:ux79 系列文章介绍本系列文章将详细介绍将Django官方引导教程中的投票项目改写为R ...
【Python】Django生成API 文档
全局配置 # DRF 全局配置 REST_FRAMEWORK = {'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema ...
CMDB建设补充：教你用django+drf 怎么去生成漂亮的API文档
废话不多说,先看效果图安装插件 pip install drf_yasg 在settings.py的INSTALLED_APPS里添加drf_yasg 在urls.py里面添加下面代码 from r ...
(转载)中文Appium API 文档
该文档是Testerhome官方翻译的源地址:https://github.com/appium/appium/tree/master/docs/cn官方网站上的:http://appium.io/s ...