django如何提供api?

导读:今天首席CTO笔记来给各位分享关于django如何提供api的相关内容,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!

Django REST framework框架之GET, POST, PUT, PATCH, DELETE等API请求接口设计

一、API接口功能需求:设计一些接口URL,让前端/客户请求这个URL去获取数据并显示,更改数据(增删改查),达到前后端分离的效果

二、设计逻辑:通过http协议请求方式GET、POST、PUT、PATCH、DELETE设计符合RESTful规范的api接口也就是URL

三、简易源码:

3.序列化serializers

#导入模型类和rest_framework序列化模块serializers

from .models import Article

from rest_framework import serializers

#定义序列化类,使用继承ModelSerializer方法

class ArticleSerializer(serializers.ModelSerializer):

class Meta:

model = Article #指定序列化的模型类

fields = \'_ all _\' #选取序列化字段,此处可自行选取字段

4.视图函数views

from django.http import HttpResponse

from django.views.decorators.csrf import csrf_exempt

from .models import Article

from .serializers import ArticleSerializer

from rest_framework.renderers import JSONRenderer

from rest_framework.parsers import JSONParser

#调用csrf装饰器csrf_exempt模块,解决跨域访问问题

#JSONRenderer它将Python的dict转换为JSON返回给客户端

#JSONParser 负责将请求接收的JSON数据转换为dict

#写法一

#在需要跨域的视图上调用装饰器@csrf_exempt

@csrf_exempt

def article_list(request):

if request.method == \'GET\':

arts = Article.objects.all() #获取模型类数据

ser = ArticleSerializer(instance=arts,many=True) #序列化数据instance

#下一步用rest_framework方法里的JSONRenderer方法渲染数据

json_data = JSONRenderer().render(ser.data)

return HttpResponse(json_data,content_type=\'application/json\',status=200)

#写法二

class JSONResponse(HttpResponse):

def _ init (self,data,**kwargs):

content = JSONRenderer().render(data)

kwargs[\'content_type\'] = \'application/json\'

super(JSONResponse, self)._ init (content,**kwargs)

#根据id进行增删改操作接口

@csrf_exempt

def article_detail(request,id):

try:

art = Article.objects.get(id=id)

except Article.DoesNotExist as e:

return HttpResponse(status=404)

备注:

*写法二中定义JSONResponse类将返回的数据data与content_type返回类型做了封装

*API接口

GET/POST

GET/PUT/PATCH/DELETE

*Postman测试效果图

django如何提供api?  第1张

django 怎么使用网站提供的api借口

webservice其实就是web api,不过为了便于统一使用了通用的数据格式,比如xml。 所以你完全可以自己使用一个第三方xml库来自己构建这样的环境,或者使用djangorestframework这样的第三方app来直接帮你快速开发

Python3.7配合Django2.0来调用钉钉(dingding)在线api实时监测员工考勤打卡情况

新冠疫情期间,大多数公司为了避免交叉感染都或多或少的采用了远程办公的方式,这显然是一个明智的选择,基本上钉钉(dingding)作为一个远程办公平台来用的话,虽然差强人意,但是奈何市面上没有啥更好的选择,矬子里拔将军,也还是可以凑合用的,不过远程办公有个问题,就是每天需要检查员工的考勤,居家办公虽然灵活,但是大家究竟有没有办公,则是另外一回事,钉钉提供的解决方案就是考勤在线打卡功能,但是检查出勤钉钉在移动端就有点费劲,需要在钉钉app里点击至少5次,还不能实时刷新,pc端的钉钉oa系统做的更烂,还不如移动端来得方便,另外如果你在一家上千人的企业里,这家企业有大大小小几十个部门,你又非常倒霉的担任这家公司的人事主管,每天按部门来出员工考勤报表就不是一件容易事了,所以利用钉钉开放的接口,使用Django自己打造一套实时监控员工考勤的web平台是我们本次的目的。

项目背景是一家普通科技公司,大概有五个部门,每个部门100人左右

首先进入钉钉开放平台 :open-dev.dingtalk.com

在企业内部开发中,选择小程序,新建一个小程序应用,这里其实也还有别的选择,比如h5微应用,主要是小程序兼容性更好一点。

填写应用的名称、简介、Logo等基本信息这些按下不表,按照要求填写即可,也不必非得填写真实信息,这里有个坑就是一定不要忘了配置安全域名或者ip,安全域名是当我们的检测平台上线的时候部署的域名,应用可以跟指定的域名进行网络通信,如果不配置的话,请求钉钉接口会报403错误。

另外还有一个坑,也就是钉钉默认开放的接口仅限于基础权限接口

如果需要考勤或者签到接口的话,还得单独点击申请,这就有点让人看不懂了,那么多接口,全都得靠用鼠标点击开通,不开通就用不了,这个用户体验真是让人非常酸爽,产品设计成这样,钉钉的pm难辞其咎。

OK,前置准备工作就已经就绪了,现在我们只要根据官方文档来写接口就可以了,选择服务端api文档:

钉钉考勤打卡的接口说明是这样的:

这里每个接口都需要一个access_token用来鉴权,这个token是用id和秘钥通过接口交换回来的,具体在应用详情里可以获取

这里我们封装成方法

搞定了token,还需要获取您的部门下所有员工的员工id,因为考勤接口参数只能接受员工id,而非部门id

最后请求考勤接口即可

完整的后台Django后台接口

这样,就可以愉快的通过线上平台来实时监测部门员工考勤了,效果是这样的:

(二)Django REST实践:最简单的REST API实现

本小节大概要花费10分钟。

在前面,我们已经学会了Django如何获得HTTP请求中的内容,以及如何获取HTTP请求的body。接下来我们就来写一个最简单的API。这个API要求在请求的HTTP body中放入JSON格式的文本,并在解析文本后进行处理,返回JSON格式的数据。

我们定义 API的URL为/api/sum/,功能是为两个数求和,并返回。

request中body的格式为:

response的格式为:

response中,我们的数据结构稍微有点复杂。

之后我们所有的REST API都会以这种统一的格式返回数据,两个不同REST API所返回内容的主要区别在data域上。

在(一)中,我们建立了一个叫做task_platform的Django项目。目录结构如下:

进入Django项目目录,并编辑task_platform中的views.py文件。

其中:

编辑task_platform/urls.py,将我们刚刚实现的API处理函数加入到路由表中。

运行Django server:

用Postman模拟请求,可以看到:

经过练习,我们已经了解如何实现一个简单的REST API了!我们之后的API都是建立在这个通讯模型之上的(当然还有一些使用GET方法的API)。在后面,我们将看看,如何通过这种模式,实现一个用户认证系统的REST API。

结语:以上就是首席CTO笔记为大家整理的关于django如何提供api的相关内容解答汇总了,希望对您有所帮助!如果解决了您的问题欢迎分享给更多关注此问题的朋友喔~

以上内容为新媒号(sinv.com.cn)为大家提供!新媒号,坚持更新大家所需的互联网后端知识。希望您喜欢!

版权申明:新媒号所有作品(图文、音视频)均由用户自行上传分享,仅供网友学习交流,不声明或保证其内容的正确性,如发现本站有涉嫌抄袭侵权/违法违规的内容。请发送邮件至 k2#88.com(替换@) 举报,一经查实,本站将立刻删除。

(0)
上一篇 2023-09-23 14:00
下一篇 2023-09-23

相关推荐

发表回复

登录后才能评论