首页 > 其他分享 >drf入门规范

drf入门规范

时间:2023-02-24 19:36:09浏览次数:37  
标签:baidu 入门 规范 name api books https com drf

1 restful规范

概念

REST全称是Representational State Transfer,中文意思是表述:表征性状态转移,它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中

10个规范

-1 数据的安全保障,通常使用https(http+ssl/tsl)协议
        -url链接一般都采用https协议进行传输
        -采用https协议,可以提高数据交互过程中的安全性
        
   -2 接口中带api标识
		-https://api.lqz.com/books
        -https://www.lqz.com/api/books    咱们用这个
            
   -3 多版本共存,路径中带版本信息
		-https://api.lqz.com/v1/login
		-https://www.lqz.com/api/v2/login
            
   -4 数据即是资源,均使用名词,尽量不出现动词(最核心的)
		-接口一般都是完成前后台数据的交互,交互的数据我们称之为资源
    	-接口形式如下
            https://api.baidu.com/users
            https://api.baidu.com/books
       -特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或是动词就是接口的核心含义、				https://api.baidu.com/login
        
        
   -5 资源操作由请求方式决定(method)
		-操作资源一般都会涉及到增删改查,我们提供请求方式来标识增删改查动作
        https://api.baidu.com/books    - get请求:获取所有书
        https://api.baidu.com/books/1  - get请求:获取主键为1的书
        https://api.baidu.com/books    - post请求:新增一本书书
        https://api.baidu.com/books/1  - put请求:修改主键为1的书
        https://api.baidu.com/books/1  - delete请求:删除主键为1的书
            
            
   -6 在请求地址中带过滤条件
		https://api.baidu.com/books?name=红&price=99
   -7 响应中状态码:两套
		-http响应状态码:1xx:请求正在处理,2xx:成功响应,3xx:重定向,4xx:客户端错误,5xx:服务端错误
    		-https://blog.csdn.net/li_chunlong/article/details/120787872
        -公司内部规定的响应状态码,放在响应体中
        	{code:0}   咱们后期一般使用100  101 102这种
    -8 返回数据中带错误信息
    	{
            code:0
    		msg: "ok/用户名错误"
		}
        
    -9 返回的结果应该符合以下规范---》好多公司不遵循这个
        GET 获取所有数据:返回资源对象的列表(数组)[{name:红楼梦,price:99},{name:红楼梦,price:99},{name:红楼梦,price:99}]
        GET 单个对象:返回单个资源对象:{name:红楼梦,price:99}
        POST 新增对象:返回新生成的资源对象:{name:西游记,price:99}
        PUT 修改对象:返回完整的资源对象 :{name:西游记,price:100}
        DELETE 删除:返回一个空文档 
        
        
    -10 响应数据中带连接

标签:baidu,入门,规范,name,api,books,https,com,drf
From: https://www.cnblogs.com/DragonY/p/17152853.html

相关文章

  • Ansible-playbook 快速入门到放弃
    Ansible-playbook快速入门到放弃隔岸红尘忙似火,当轩青嶂冷如冰。1-简介playbook相当于可以把模块命令都写入到配置文件里面,这样就可以直接执行配置文件了,类似......
  • 深度学习这些“坑”你们有没有踩过(入门误区)
    首先和大家说一声对不起,昨天由于平台安全问题,账号被黑入,发送了与本平台主旨背道而驰的内容,发现问题我们立马删除了,在此向大家说一声抱歉。​我们“计算机视觉战队”微信公众......
  • jedis快速入门 String数据结构操作
    jedis一款java操作redis数据库的工具使用步骤下载jedis的jar包  使用获取连接Jedisjedis=newJedis("localhost",6379)操作je......
  • (数据库系统概论|王珊)第六章关系数据理论-第二节:规范化
    ​​pdf下载:密码7281​​​​专栏目录首页:【专栏必读】(考研复试)数据库系统概论第五版(王珊)专栏学习笔记目录导航及课后习题答案详解​​本节其实就干了两件事情:首先讨论一个......
  • GIt Flow(一种git开发规范)
    一、前言gitflow是团队通过git进行合作的一种对代码进行管理的规范,主要作用是保证协同工作的顺利进行和代码的正常运行。二、概括规范中代码分为两大分支(dev、master),ma......
  • docker swarm快速入门篇
    目录一.dockerswarm集群部署1.初始化manager节点2.worker节点加入集群3.查看集群节点列表4.给节点添加label5.将work节点提升为manager角色以实现高可用6.查看node信息7.......
  • Python:Excel自动化实践入门篇 甲【留言点赞领图书门票】
    *以下内容为本人的学习笔记,如需要转载,请声明原文链接微信公众号「englyf」https://mp.weixin.qq.com/s?__biz=MzUxMTgxMzExNQ==&mid=2247485524&idx=1&sn=7af7790002e0e60......
  • Git从入门到实践,掌握现代软件开发必备工具!
    如何学习Git?学习Git需要耐心和练习。通过反复练习和尝试,你将更好地掌握Git的使用。在学习的时候可以参考一下方法! 学习目录:1、了解Git的基本概念Git是一个版本控......
  • Arseed 上传图片 快速入门
    快速入门为了方便开发者入门,我们部署了 web3infra.dev 方便开发者永存数据。快速入门将介绍如何使用arseeding-js将数据存通过 web3infra.dev 存储到Arweave网络......
  • Django DRF接口开发之多表字段数据返回
      关于Serializer序列化数据,一般情况一个实体Model对应一个Serializer,其实功能跟FromModel有点类似。但是在涉及到多表关联查询,序列化数据接口进行返回时,无法返回......