02 restful接口规范

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         删掉一个     params传参    
    /books/(pk)    put            总体升级一个
    /books/(pk)    patch          部分升级一个

6) 资源通常涉及到数据信息的各种各样操作方式 - 挑选	、排列
、限定
    api.baidu.com/books/?search=西&ordering=-price&limit=3

• 回应数据信息 便是下边的JsonResponse，回到给前端开发的数据信息

1) http请求的回应会出现回应状态码	，接口用于回到操作的资源数据信息
，能够有着 操作数据信息結果的 状态码
    status  0(操作资源取得成功)  1(操作资源不成功)  2(操作资源取得成功，但没搭配結果)
    注：资源状态码不象http状态码	，一般全是后台管理与前台接待或者顾客承诺的
2) 资源的状态码文本提醒
    status  ok    '账户不正确'  '登陆密码不正确'  '客户锁住'
3) 资源自身
    results
    注：删掉资源取得成功不做一切数据信息回到(回到空字符串)
4) 不可以立即放入的资源(子资源、照片	、视頻等资源)
，回到该资源的url链接