resful介绍, Django安装这个东西

Django安装 pip3 install djangorestframework
在settings的app中注册一下'rest_framework',

  1. 什么是resful(定义)

    • 是一个规范
    • 面向资源编程:把网络中所有东西,想象成资源
  2. 规范:

    -10条规范
    1. API与用户的通信协议,总是使用HTTPs协议:https比http安全
    
    2. 域名 
        https://api.example.com  尽量将API部署在专用域名(会存在跨域问题)
        https://example.org/api/  API很简单
            例如写一个查询所有图书的api接口:https://api.example.com/books
                                    https://127.0.0.1/api/books
                                    
    3. 版本:每个接口都应该有版本
        URL,如:https://api.example.com/v1/    https://127.0.0.1/api/v2/books(推荐用这种)
        请求头 跨域时,引发发送多次请求
    
    4. 路径,视网络上任何东西都是资源,均使用名词表示(可复数)
        https://api.example.com/v1/books
        https://api.example.com/v1/animals
        https://api.example.com/v1/employees
     不能这么写:
            -获取所有图书:https://127.0.0.1/api/get_all_books
            -新增一本书:https://127.0.0.1/api/add_book
        同一都用这个:
        https://api.example.com/v1/books
    
    5. method
        GET      :从服务器取出资源(一项或多项)
        POST    :在服务器新建一个资源
        PUT      :在服务器更新资源(客户端提供改变后的完整资源)
        PATCH  :在服务器更新资源(客户端提供改变的属性)
        DELETE :从服务器删除资源
    
    6. 过滤,通过在url上传参的形式传递搜索条件
     https://api.example.com/v1/zoos?limit=10:指定返回记录的数量
    
    7. 状态码
        请求回去,需要有状态码
        自定义状态码
        status: 100表示成功
        101表示用户名密码错误
        102我也不知道什么错误
    
    8. 错误处理,应返回错误信息,error当做key。
     {status:100,error:'错误信息写上'}
    
    9. 返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范。
        GET /books:返回资源对象的列表(数组)
        GET /books/1:返回单个资源对象
        POST /books:返回新生成的资源对象    -新增,传数据,一旦新增完成,把新的资源对象返回
        PUT /books/1:返回完整的资源对象
        PATCH /books/1:返回完整的资源对象
        DELETE /books/1:返回一个空文档
    
    10. Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法
     使得用户不查文档,也知道下一步应该做什么。
        {
            status:100
            msg:成功
            url:127.0.0.1/books/1
        }
     核心:返回结果中提供链接
    
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,204评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,091评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,548评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,657评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,689评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,554评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,302评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,216评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,661评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,851评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,977评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,697评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,306评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,898评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,019评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,138评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,927评论 2 355

推荐阅读更多精彩内容