nbwhg / djangorestframework-book

Django REST framework 3 中文文档, API参考, 最佳实践指南

介绍

---

注意: 本文档针对的是REST framework的版本3。

编写本文档时，所用的版本号：

• Django(1.11.10)
• djangorestframework(3.7.7)
• Python(3.6.4)

---

Django REST framework 是一个功能强大的灵活的构建Web APIs的工具包。

为什么要使用REST framework ?

• 基于Web 浏览器的API 可视化，对于你的开发将会有很大的帮助
• 身份认证策略包含OAuth1a和OAuth2
• 同时支持ORM和非ORM的数据源的序列化
• 完整的REST API 功能支持, 包括认证、权限、限流、分页等
• 可定制化 - 如果不需要功能强大的特性，那么可以基于基础的功能类(function-based)进行开发
• 文档完善，社区活跃
• Mozilla, Red Hat 等公司正在使用REST framework

---

什么人适合本文档？

阅读本文档之前，至少要对Django有一定的了解。

---

项目源码

项目源码存放于Github上，https://github.com/bigtree6688/djangorestframework-book。

---

在线阅读

可以通过GitBook或者Github来在线阅读。

---

目录

• 安装
  1. 介绍
  2. 安装
  3. 举例
• 快速上手
  1. 创建项目
  2. 序列化
  3. 视图
  4. 路由
  5. Settings
  6. 测试API
• 完整教程
  1. 序列化
  2. Requests & Responses
  3. 类视图
  4. 认证和权限
  5. 关系和超链接
  6. 视图集合和路由
  7. coreapi
• API指南
  1. Requests
  2. Responses
  3. 视图Views
  4. 通用视图Generic views
  5. 视图组Viewsets
  6. 路由器Routers
  7. 解析器Parsers
  8. 渲染器Renderers
  9. 序列化器Serializers
  10. 序列化器字段Serializer fields
  11. Serializer relations
  12. 校验器Validators
  13. 身份验证
  14. 权限
  15. 限流Throttling
  16. 过滤
  17. 分页
  18. API 版本化
  19. 内容协商Content negotiation
  20. 元数据
  21. Schemas
  22. Format suffixes
  23. Returning URLs
  24. 异常处理
  25. 状态码
  26. 测试
  27. Settings
• 最佳实践
  1. API文档生成
  2. HTML & Forms
  3. AJAX & CSRF & CORS