drf框架接口文档
发布时间:2020-12-15 17:10:38 所属栏目:大数据 来源:网络整理
导读:drf框架接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自 APIView 及其子类的视图。 一.安装依赖 pip install coreapi 二.设置接口文档访问路径 在总路由中添加接口文档路径。 文档路由对应
drf框架接口文档REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自 一.安装依赖
二.设置接口文档访问路径在总路由中添加接口文档路径。 文档路由对应的视图配置为 参数
三.文档描述说明定义位置1) 单一方法的视图,可直接使用类视图的文档字符串,如
2)包含多个方法的视图,在类视图的文档字符串中,分开方法定义,如
3)对于视图集ViewSet,仍在类视图的文档字符串中封开定义,但是应使用action名称区分,如
四.访问接口文档网页有两点要说明1) 视图集ViewSet中的retrieve名称,在接口文档网站中叫做read 2)参数的Description需要在模型类或序列化器类的字段中以help_text选项定义,如:
或 (编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |