(生鲜项目)20. drf文档功能简介
1.REST framework可以自动帮助我们生成接口文档。接口文档以网页的方式呈现。
自动接口文档能生成的是继承自APIView
pip install coreapi
2.使用方法
from rest_framework.documentation import include_docs_urls urlpatterns = [ ... # 生成DRF文档的配置 url(r'^docs/', include_docs_urls(title="慕学生鲜")), ... ]
3. 浏览器访问, 此时肯定会报错, 'AutoSchema' object has no attribute 'get_link', 原因如下, 即从3.10开始 REST就把 AutoSchema 从 coreapi 迁移到了OpenAPI 里,
如果你还仍然要使用coreapi模块, 那么就需要单独配置, settings.py
REST_FRAMEWORK = { ... # 解决 'AutoSchema' object has no attribute 'get_link' 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' ... }
4. 再次测试, 访问成功, 界面模块如下
5. 如何写提示信息
6. 如何给参数添加描述(非常重要), help_text属性
7. 用户认证模块
然后再去查userfav的list, 就可以正常返回了
8. 对于使用了自定义filter的表来说, 文档的交互功能并不是非常好, 例如 goods的list交互界面如下左, 而使用rest的API界面的过滤界面见右下, 明显后者更加人性化, 所以实际情况中, 应该结合两者一起来用, 尽量多使用文档
部分转载自 https://www.cnblogs.com/knighterrant/p/10597651.html
--- 君子处其实,不处其华;治其内,不治其外 张居正 ----