• DRF框架:接口 ,restfui接口规范,基于restful规范的原生Django接口,Postman接口工具


    DRF框架

    全称:django-rest framework

    接口

    接口:联系两个物质的媒介,完成信息交互
    web程序中:联系前台页面与后台数据库的媒介
    web接口组成:
        url:长得像放回数据的url链接
        请求参数:前台按照指定的key提供数据给后台
        响应数据:后台与数据库交互后将数据反馈给前台 

    restful接口规范

    接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据
    
    如何写接口:接口规范是 规范化书写接口的,写接口要写 url、响应数据
    
    注:如果将请求参数也纳入考量范围,那就是在写 接口文档
    • url

    1) 用api关键字标识接口url
        api.baidu.com | www.baidu.com/api
        
    2) 接口数据安全性决定优先选择https协议
    
    3) 如果一个接口有多版本存在,需要在url中标识体现
        api.baidu.com/v1/... | api.baidu.com/v2/...
        
    4) 接口操作的数据源称之为 资源,在url中一般采用资源复数形式,一个接口可以概括对该资源的多种操作方式
        api.baidu.com/books | api.baidu.com/books/(pk)
        
    5) 请求方式有多种,用一个url处理如何保证不混乱 - 通过请求方式标识操作资源的方式
        /books        get            获取所有
        /books        post        增加一个(多个)
        /books/(pk)    delete        删除一个
        /books/(pk)    put            整体更新一个
        /books/(pk)    patch        局部更新一个
    
    6) 资源往往涉及数据的各种操作方式 - 筛选、排序、限制
        api.baidu.com/books/?search=西&ordering=-price&limit=3
    • 响应数据

    1) http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有 操作数据结果的 状态码
        status  0(操作资源成功)  1(操作资源失败)  2(操作资源成功,但没匹配结果)
        注:资源状态码不像http状态码,一般都是后台与前台或是客户约定的
        
    2) 资源的状态码文字提示
        status  ok    '账号有误' | '密码有误' | '用户锁定'
        
    3) 资源本身
        results
        注:删除资源成功不做任何数据返回(返回空字符串)
        
    4) 不能直接放回的资源(子资源、图片、视频等资源),返回该资源的url链接

    基于restful规范的原生Django接口

  • 相关阅读:
    PHP header的几种用法
    Elasticsearch 学习笔记
    elsearch 安装过程中遇到的错误解决方式
    python常用模块
    python 列表和字段的相关函数
    Nginx+Redis+Ehcache大型高并发高可用三层架构总结
    Docker技术底层架构剖析
    ELK日志分析平台环境部署 (yum安装)
    禁止root直接登陆linux系统
    浅谈Rsync+Inotify实时同步
  • 原文地址:https://www.cnblogs.com/komorebi/p/11674788.html
Copyright © 2020-2023  润新知