django rest framework注释自动生成

最新推荐文章于 2020-11-09 22:25:58 发布
最新推荐文章于 2020-11-09 22:25:58 发布
阅读量1.1w 收藏 1
点赞数 1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_32502511/article/details/82745395
版权

自己为了偷懒，简单写了个根据Model代码自动生成rest framework接口描述文档的html字符串的小工具，效果如下：

在线测试地址：http://www.liuyanlin.cn/notes

打开页面在上面填入相关的参数，就可以生成如下效果如图：

然好将生成的html字符串复制到rest framework项目的对应 ViewSet 类下的注释里面即可，如图：

这样就可以在自己接口项目中加接口文档描述时提高效率，就像下面我的rest项目生成的描述一样

 

刘延林
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
DRF API documentation 加注释小技巧
Hayley-L
05-10 875
各请求方法加注释 效果图： 继承GenericViewSet，mixins时： from rest_framework import mixins from rest_framework.viewsets import GenericViewSet class MyViewSet(mixins.CreateModelMixin, mixins.Re...
django-rest-swagger对API接口注释的方法
01-20
在使用 django-rest-framework 进行API开发，可以使用django-rest-swagger接入swagger自动生成接口文档。 1. 安装django-rest-swagger pip install django-rest-swagger 2.配置settings.py INSTALLED_APPS = [ .....
Django Rest Framework - 实例PartyDemo 之 API文档
原小明
01-22 5710
1.文档选择在官网上 推荐了两种API文档方案 DRF Docs 和 Swagger 。DRF Docs 界面预览： 官方文档 ：http://drfdocs.com/installation/Swagger 界面预览 ： 官方文档 ： http://marcgibbons.github.io/django-rest-swagger/两个各有千秋，不过我喜欢颜值高的 DRF Docs。 官方文档
Django restframework 自动生成api文档
Bob欧巴のblog
07-11 5250
自动生成api接口文档,是restframework自带的功能,生成的文档超级详细,既省去了后端人员写文档的时间,也能让前端用起来欲仙欲死. 不过因为是restframework的功能,目前只能生成调用了restframework类视图的接口,普通的view视图接口不会生成,当然这只是我自己测试了一下后得出的结论,可能有别的方法,这里就不讨论这个,咱们进入正题 restframework 自动...
【接口文档】Django restful framework中自动生成API文档
Allen . Liu
02-25 1835
Django restful framework中自动生成API文档 自动生成api文档（不管是函数视图还是类视图都能显示） 1.安装rest_framework_swagger库 pip install django-rest-swagger 2.在项目下的 urls.py 中加入如下： from rest_framework_swagger.views import get_sw...
Django Rest Framework 3.8 自动生成 API 文档
热门推荐
刘延林
05-17 1万+
使用 Django Rest Framework 3.8 自动生成 API 文档原文地址：https://www.jianshu.com/p/dc77f652e7d7pip install djangorestframework pip install markdown pip install django-filter pip install django-rest-swaggerdjango-...
standard-prototype:Svelte、Django Rest Framework 和 Firebase Prototype Starter
05-29
该原型的最新版本现已完全自我托管，可以在以下位置获得： 标准原型Svelte、Django Rest Framework 和 Firebase Prototype Starter先决条件： 创建 Firebase 应用程序 ( ) 不需要 Firestore，只需一个项目，然后在...
announces-api:Django Rest Framework项目，用于处理“公告”和“评论”原始操作
04-03
使用Django Rest Framework构建的annnounces-api，并处理“ announces”和“ comments” crud操作 特征： 身份验证系统（BasicAuthentication，SessionAuthentication，TokenAuthentication） 宣布crud操作（使用...
srvup-rest-framework:扩展Srvup Membership项目，我们使用Django Rest Framework构建API
05-25
Srvup和Django Rest框架 通过使用先前构建的名为Srvup Membership（ ）的Django项目创建API 每个讲座名称都链接到相关的源代码。 最终项目代码已更新为Django 1.8 讲座代码 带CBV的CRUD-ListView 带CBV的CRUD-...
Online-Course-By-Django-AngularJS:该网站是使用Django，Django Rest Framework（DRF）和AngularJS构建的
05-04
在本系列循序渐进的系列文章中，将利用Django Rest Framework的RESTFUL API服务将Django和AngularJS结合在一起。 建立在以下之上： 订阅我们的 感谢收看！ 团队CFE 讲座代码 11-后端API序列化程序更新 12-使用...
Django中rest_framework的十大组件作用及使用方法
rt5476238的博客
08-04 911
Django后端开发 后端为前端提供URL(API接口) 返回json数据 反射 对象有几种方法用来操作自己的属性或方法：getattr(object, name), hasattr(object, name), setattr(object, name, value), delattr(object, name) １、有时我们要访问某个变量或是方法时并不知道到底有没有这个变量或方法，所以就要做...
django restframework choice 自定义输出数据
Crazy博客
05-07 1797
我有一个这样的需求，返回的数据json中返回的是id，但是我想要得到该id对应的name。 id对应的name PlatformType = ( (0, '通用'), (1, '前装'), (2, '后装'), (3, '海外前装'), (4, '海外后装'), (5, '小系统') ) class TrackS...
Django restframework 实现文件下载(json)
weixin_41678663的博客
12-15 4072
class DoView(APIView): def get(self,request): queryset = self.get_queryset() serializer = self.get_serializer(queryset, many=True) # 构造文件名 file_name = datetime.d...
DRF 框架总结 - 自动生成接口文档
qyf__123的博客
12-14 1953
自动生成接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自APIView及其子类的视图。 1. 安装依赖 REST framewrok生成接口文档需要coreapi库的支持。 pip install coreapi 2. 设置接口文档访问路径 在总路由中添加接口文档路径。 文档路由对应的视图配置为rest_frame...
在一个从左到右，从上到下递增的数组中找到给定的数值
weixin_43997764的博客
11-09 2647
如题 [ [1,2,3], [3,4,5] ] 对于这种如果暴力搜索肯定超时，观察数组特征，从左下角开始，1=行数-1，j=0，如果target大于当前值，则列指针向右走，j++，如果target小于当前值，行指针向上走i– #include <iostream> #include <vector> using namespace std; bool findTarget(vector<vector< int>>& v,int target) {
使用Django REST Framework来快速实现API调用服务——上篇（运行环境和模型层）
hyman.lu
06-05 3118
本文简单介绍了什么是RESTful API，以及如何搭建Django环境以及编写模型层代码，并如何利用Django的强大可视化数据库管理功能。
django 模板语言的注释操作
weixin_30572613的博客
12-21 488
Django在HTML里面书写的模板语言不能使用这种方法注释，这样注释实际依然有效 <!--{% if text %}--> 第一种使用模板标签{% comment %}注释，这是块注释 {% comment %} {% if text %} xxxxxxx xxxxxx {% endcomment %} 第二种是...
Django rest_framework 接口调试页面静态资源丢失问题
ssjdoudou的博客
09-27 9594
服务器nginx配置 前往nginx配置文件（参考路径：/etc/nginx/nginx.conf），添加对应的配置如下： location /static/rest_framework/ { alias /usr/local/lib/python3.6/dist-packages/rest_framework/static/rest_framework/ ;} 这个每个人不一定一样，切...
rest_framework之规范详解 00
aaronthon的博客
06-22 365
&#13; 接口开发&#13; 方式1：缺点：如果有10张表，则需要40个url.&#13; urls.py&#13; &#13; views.py&#13; &#13; 缺点：如果有10张表，则需要40个url.    接下来就出现了resrful 规范,比较简洁  &#13; 方式2：resrful 规范（建议）  url简洁了，只有一条。&#13; 1. 根据metho...
django restframework 调查问卷系统
最新发布
01-19
Django Rest Framework 是一个用于构建 Web API 的强大工具，它可以帮助我们快速开发各种类型的 Web 项目，包括调查问卷系统。在使用 Django Rest Framework 构建调查问卷系统时，我们可以利用其提供的丰富功能和...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

刘延林

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值