Django实现统一包装接口返回值数据格式

最新推荐文章于 2024-04-11 08:52:48 发布

原创

最新推荐文章于 2024-04-11 08:52:48 发布 · 2.7k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#计算机

本文介绍了如何在Django项目中实现统一的接口返回值数据格式，通过自定义错误处理和响应包装，简化代码配置，并提供关键代码示例。文章提及使用DjangoStarter脚手架进行改造，并对比了与.NET Core包装返回值的简易性。完整代码可在GitHub找到。

Python微信订餐小程序课程视频

https://edu.youkuaiyun.com/course/detail/36074

Python实战量化交易理财系统

https://edu.youkuaiyun.com/course/detail/35475

前言

最近实在太忙了，开始了一个新的项目，为了快速形成产品，我选择了Django来实现后端，然后又拿起了之前我封装了项目脚手架「DjangoStarter」。

由于前段时间我写了不少.NetCore的后端代码，对CRUD的接口开发又有了一些新的理解，所以肯定也要把DjangoStarter改造一番，改得更加顺手~

题外话：话说我在前端终于真正用上react，不得不说 ts + react 真好用，「前端带师」的安利可真不错啊（妙啊

正题

准确来讲是搭配DjangoRestFramework来实现的，核心代码分为两部分，一个是错误处理包装，一个是响应包装renderer。

无论请求是否报错，都会被我们自定义的renderer包装。

代码

开始上代码吧~

首先在项目里添加一个新的Python包，位置根据情况自行安排，我在DjangoStarter模板中的位置是utils/response，接下来的两个文件都会放在这个目录中

第一个

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

pythonxxoo

关注关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

django之十七--如何提供一个规范的接口返回值

1、测试博主技术知识分享 2、pos行业知识技术分享 3、java后端技术知识分享 4、嵌入式技术知识分享 5、运维部署相关知识分享

03-08

732

一、前言首先，整体的开发思路是：比如一个前端开发人员A和一个后端开发人员B，一起联调一个【查询用户数据】功能，那么前端开发人员A就负责【查询用户数据的页面】的开发，后端开发人员B就负责【查询用户数据的接口】的开发且开发完成且自测通过后提供给前端开发人员A进行联调。我们要知道，前端开发人员A和后端开发人员B一起开发这个功能的前提都是要严格产品人员编写的需求文档和原型图进行开发的。所以前端开发人员A在实际开发过程中会要求后端开发人员提供的【查询用户数据的接口】的返回值必须满足这两点： ⑴.必须有返

django restframework 如何自定义统一响应和异常的返回格式

hyfand1的博客

11-22

1465

django restframework 如何自定义统一响应和异常的返回格式

1 条评论您还未登录，请先登录后发表或查看评论

djangorestframework统一json返回数据

zxc19854的博客

08-12

1147

djangorestframework 可以帮我们快速开发出一个遵循restful规范的程序，我们可以通过定义一些方法，来统一这套resuful的返回格式 from rest_framework.response import Response # 自定义状态码 class HttpCode(object): # 正常登陆 ok = 200 # 参数错误 paramserror = 400 # 权限错误 unauth = 401 # 方法错误

django中怎么实现统一返回格式和状态码？

LoveJKing的博客

04-23

3007

在生产环境中，你可能还需要考虑对响应数据进行适当的格式化，以保证返回的数据结构一致。此外，你可能需要为不同类型的响应（如HTML页面、JSON数据、文件下载等）添加特定的处理逻辑。在Django中，要实现统一的返回格式和状态码，可以通过自定义一个中间件来实现。，这个示例中的中间件将不会进行处理。你可以根据自己的需求修改这个逻辑。首先，在你的项目或应用中创建一个新的中间件文件，例如。注意，如果原始响应已经是一个。

jira自定义字段去掉none选项_Django rest_framework自定义统一返回格式Response

weixin_39631467的博客

12-01

271

内容提要：rest_framework返回统一格式的Response。在前后端分离的项目中，后端通常需要统一的返回格式，一般包含code、message和data三个字段。前端和测试人员可以通过约定的返回信息，获得后端执行结果。在Django的rest_framework中，默认使用rest_framework.response的Response返回给前端。这里我们可以新建一个工具类，自...

在Django中间件处对API进行统一处理

温柔小猪的博客

10-04

1029

前言公司实习时遇到一个问题:项目中所使用不是Restful API,每个视图函数都要先生成字典，于是项目中便充斥着如下的代码:1 2 3 4 5 6 result={ "msg":'xx", "status":200, "result":data } return HttpResponse(js...

帮鞋写一个装饰器，可以自动捕获django接口中的返回值

最新发布

07-15

</think>### 如何编写装饰器自动捕获 Django 接口返回值 在 Django 中，可以通过装饰器统一处理视图函数的返回值，将其封装为规范的 JSON 响应。以下是实现步骤和代码示例： --- #### 1. **基础装饰器实现** ```...

【自定义HTTP装饰器教程】：在Django中实现功能的个性化扩展

HTTP装饰器是特殊函数，用于包装Web请求处理器（如视图），以实现认证、缓存、日志记录等功能。这些装饰器在Django应用中扮演着中间人的角色，能够在不修改原始函数代码的情况下，为函数添加新的

snapcastHttpd: Python实现的HTTP守护程序包装器

快照式HTTP守护程序包装器是一种网络服务程序，它将现有HTTP服务的功能通过特定的API接口封装起来，为外部请求提供统一的数据交换格式和服务。snapcastHttpd通过这种方式可以使得各种不同的客户端都能以一致的方式与...

Django+RestFramework API接口及接口文档并返回json数据操作

09-16

主要介绍了Django+RestFramework API接口及接口文档并返回json数据操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧

DjangoStarter:基于Django定制的快速Web开发模板，功能包括：Docker-Compose部署，缓存，业务代码生成器，接口限流，DjangoAdmin验证码，登录次数尝试，屏蔽了RestFramework默认的API主页等

05-07

Django Starter 基础框架这个项目是我为了满足公司安全部门的要求，定制了一个基于Django的Web框架，功能包括：给DjangoAdmin加上验证码，并且加入登录次数尝试，屏蔽了RestFramework默认的API主页，使外部访问无法看到所有接口。后续我会根据实际工作继续添加一些其他功能以方便团队快速搭建应用~ features 业务代码生成器（新） admin后台安全限制中间件（需手动启用）非debug模式下管理员可以查看报错信息（需手动启用）自定义访问前缀支持Docker部署（使用docker-compose方式）支持uWsgi部署，支持uWsgi自动重启默认启用CORS_ALLOW实现接口跨域基于SimpleUI定制的管理后台管理后台支持登录验证码和登录尝试次数限制集成RestFramework，默认屏蔽了链接主页，即对外隐藏API 对默认的s

hasura-django-starter:Hasura 最好的即时、实时 GraphQL API 与 Django 的内置身份验证模型以及跨两个服务扩展逻辑的能力相结合

05-29

Hasura + Django Starter (HDS) 一个将Hasura的最佳功能与Django配对的项目启动器 :red_heart: （现在 Svelte 客户端示例增加了 100%） Hasura 最好的即时、实时 GraphQL API 与 Django 的内置身份验证模型以及跨两个服务扩展逻辑的能力相结合。哈苏拉为任何 Postgres 数据库自动生成 GraphQL API。数据库管理界面。行级权限管理系统。事件（通过 Django 从 Hasura 触发发送新用户和忘记密码电子邮件的示例）。操作（带有示例操作，用于演示 Hasura 和 Django 之间更高级的非 CRUD 逻辑）。数据库/元数据迁移（和容器自动应用）。 Django的注册、登录和密码重置身份验证流程（基于 REST）。 JWT 令牌（Simple-JWT），通过 Django 的内置

Django实现DRF数据API接口格式封装

Mr数据杨

08-25

1123

在 Django 中，可以通过中间件全局地自定义 API 响应的格式，确保所有的 API 返回的数据结构一致。下面是实现这一功能的具体步骤。创建自定义应用在项目中创建一个名为Utils的应用，专门用于存放工具类和中间件。在项目的文件中，将新创建的应用Utils添加到# 其它应用'Utils', # 工具管理定义自定义中间件在Utils应用中，创建一个名为的文件，编写自定义的，用于拦截并处理所有的 API 响应。# 根据状态码设置响应消息else:# 重新组织响应数据})将中间件添加到项目中。

Django+RestFramework实现API接口及接口文档并返回json数据

AdeCary的博客

01-29

6767

系统：ubuntu18.04 x64 GitHub：https://github.com/xingjidemimi/DjangoAPI.git 安装 pip install django==2.1.5 pip install djangorestframework # rest api pip install coreapi pygments markdown # 自动化接口文档 API示例 ...

Restful API接口规范(以Django为例)

AZURE060606的博客

04-11

946

Restful API的接口架构风格中制定了一些规范，

自定义 rest_framework 响应返回格式

qq_31080741的博客

12-22

436

自定义 rest_framework响应返回格式

string转timestamp格式月份错误_RestFul API 统一响应格式与自动包装

weixin_39610807的博客

12-05

290

文章为本人原创，创作不易，如果对您有帮助，点赞收藏加关注。如今我们的项目已大多是前后端分离的方式，而且有些微服务也是采用http的形式进行交互，使用一套前后端或多个服务之间约定好响应格式是很有必要的，这面文章介绍两种响应的格式。响应结构的两种形式方式一：包装响应格式，会在真正的响应数据外面包装一层，比如code、message等数据，如果接口报错，响应Status依然为200，更改响应数据里的co...

01----------统一封装返回信息{code,msg,data}