django如何写接口(django自动生成接口文档)

DjangoRESTframework（一）:接口与规范

1)用api关键字标识接口url

2)接口数据安全性决定优先选择https协议

3)如果接口有多个版本存在，需要在url中标识体现

4)接口参数的数据源称之为资源，在url中一般采用资源复数形式，一个接口可以概括对该资源的多种操作方式

5)请求方式有多种，用一个url处理如何保证不混乱-通过请求方式标识操作资源方式

2）资源的状态码文字提示

4)不能直接返回的资源（子资源、图片、视频等资源），返回该资源的url链接

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

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

三、简易源码：

3.序列化serializers

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

from.modelsimportArticle

fromrest_frameworkimportserializers

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

classArticleSerializer(serializers.ModelSerializer):

classMeta:

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

fields='_all_'#选取序列化字段，此处可自行选取字段

4.视图函数views

fromdjango.httpimportHttpResponse

fromdjango.views.decorators.csrfimportcsrf_exempt

from.modelsimportArticle

from.serializersimportArticleSerializer

fromrest_framework.renderersimportJSONRenderer

fromrest_framework.parsersimportJSONParser

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

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

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

#写法一

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

@csrf_exempt

defarticle_list(request):

ifrequest.method=='GET':

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

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

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

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

returnHttpResponse(json_data,content_type='application/json',status=200)

#写法二

classJSONResponse(HttpResponse):

def_init(self,data,**kwargs):

content=JSONRenderer().render(data)

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

super(JSONResponse,self)._init(content,**kwargs)

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

@csrf_exempt

defarticle_detail(request,id):

try:

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

exceptArticle.DoesNotExistase:

returnHttpResponse(status=404)

备注：

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

*API接口

GET/POST

GET/PUT/PATCH/DELETE

*Postman测试效果图

结语：以上就是首席CTO笔记为大家介绍的关于django如何写接口的全部内容了，希望对大家有所帮助，如果你还想了解更多这方面的信息，记得收藏关注本站。